Tag
Tags can be used to display states (Active, Cancelled...) in lists, tables, etc.
Figma Reference
Tag Usage
import { Tag } from '@dt-dds/react-tag';
export const App = () => {
return <Tag>Active</Tag>;
};
Properties
Tag
| Property | Type | Default | Description |
|---|---|---|---|
children | ReactNode | - | Child components to be rendered |
dataTestId | string | tag | Customizable test identifier |
variant | TagVariant | solid | Determines the variant of the tag |
color | TagColor | primary | Determines the color of the tag |
size | TagSize | small | Determines the size of the tag |
border | TagBorder | squared | Determines the border style of the tag |
isDisabled | boolean | false | Specifies if the element should be disabled |
isClickable | boolean | false | Specifies if the element should have the clickable styles |
onClick | function | - | The triggered function when the tag is clicked. This also applies the clickable styles. If the component has the onClose property this will not be triggered |
onClose | function | - | The triggered function when closing the tag |
Stack
- TypeScript for static type checking
- React — JavaScript library for user interfaces
- Emotion — for writing css styles with JavaScript
- Storybook — UI component environment powered by Vite
- Jest - JavaScript Testing Framework
- React Testing Library - to test UI components in a user-centric way
- ESLint for code linting
- Prettier for code formatting
- Tsup — TypeScript bundler powered by esbuild
- Yarn from managing packages
Commands
yarn build- Build the packageyarn dev- Run the package locallyyarn lint- Lint all files within this packageyarn test- Run all unit testsyarn test:report- Open the test coverage reportyarn test:update:snapshot- Run all unit tests and update the snapshot
Compilation
Running yarn build from the root of the package will use tsup to compile the raw TypeScript and React code to plain JavaScript.
The /dist folder contains the compiled output.
tag
└── dist
├── index.d.ts <-- Types
├── index.js <-- CommonJS version
└── index.mjs <-- ES Modules version
...
Versioning
Follows semantic versioning
© License
Licensed under MIT License