This guide walks you through setting up the @vacui-kit library in your Angular project.

Install

Prerequisites

  • Angular - v17.3.0 or higher.
Loading syntax highlighter...

Getting started

For developers looking to leverage the full suite of the directive functionality with minimal setup, importing the PrimitivesModule of each directive set offers an easy way to get started. Each module includes all necessary directives for creating a component:

Loading syntax highlighter...

Each directive in @vacui-kit/primitives is designed as standalone. Incorporating the root primitive from each set is essential. The root primitive orchestrates the shared state, seamlessly aligning the functionalities of child directives to ensure cohesive operation within your application.

For more granular control, you can choose to import only the specific directives you need.

Loading syntax highlighter...

Using the primitives

Once you have imported the PrimitivesModule into your module or standalone component, you are ready to incorporate the directives directly within your templates. Here is a quick snippet to demonstrate its usage:

Loading syntax highlighter...