Installation
Install the Package
bash
npm install @yellowcard/b2b-design-systemPeer Dependencies
The design system requires the following peer dependencies:
| Package | Version |
|---|---|
vue | ^3.5.0 |
pinia | ^2.0.0 || ^3.0.0 |
vue-router | ^4.6.0 |
@vuepic/vue-datepicker | ^12.0.0 |
Install any you don't already have:
bash
npm install vue pinia vue-router @vuepic/vue-datepickerImport Styles
The design system's compiled CSS must be imported in your application entry point:
ts
// main.ts or App.vue
import '@yellowcard/b2b-design-system/style.css';Vite Configuration
No special Vite configuration is required. The package ships as ES modules with preserved module structure, so tree-shaking works out of the box.
If you want to use the SCSS tokens directly, ensure you have sass-embedded installed:
bash
npm install -D sass-embeddedTypeScript
The package includes full TypeScript declarations. No additional @types/* packages are needed.
Import types directly:
ts
import type { ButtonProps } from '@yellowcard/b2b-design-system';
// or
import type { ButtonProps } from '@yellowcard/b2b-design-system/Button';DatePicker Setup
The DatePicker component requires its peer dependency styles. Import them alongside the main styles:
ts
import '@yellowcard/b2b-design-system/style.css';The DatePicker styles are included in the main style.css bundle.