Getting Started
The @xerius/codey-components package contains a set of VueJS components following the style guidelines.
More information about the installation can be found here.
Dependencies
The @xerius/codey-style package is required for providing the styling.
Side Menu Icons
Icon | Description |
---|---|
❌ | Marks deprecated components that should not be used anymore. The docs are still present for references and migration info. |
📚 | Marks components that are from or use an external library. |
Codey Playground
The codey-playground
is intended to provide a real-life application where codey-components
are set up together with their required packages. This allows us to test and developed in a realistic environment.
If you want a quick overview of all components and play with them in a full setup Vue app you can by following these steps:
- Clone the
Codey
code repo. - Make sure to install all dependencies needed using
npm install
. - Build all the
Codey
packages withnpm run build
. - When all packages are built you can open the Playground using
npm run dev:playground
. - In the left side nav bar, you can navigate to the component you wish to try out.