Link
The link component is used as a navigational element to navigate users to another location and it allows to easily customize anchor elements.
Figma Reference
Figma - Standalone link Figma - Inline link
Link Usage
import { Link } from '@dt-dds/react-link';
export const App = () => {
return <Link href='/'>Some text</Link>;
};
Properties
| Property | Type | Default | Description |
|---|---|---|---|
as | ElementType | a | Renders the link as a different element or component |
children | ReactNode | - | Child components to be rendered |
dataTestId | string | link | Customizable test identifier |
onClick | function | - | The triggered function when the Link is clicked |
isDisabled | boolean | false | Specifies if the element should be disabled |
size | LinkSize | medium | Specifies the text size of the element |
variant | LinkVariant | standalone | Specifies the type of link |
color | LinkColor | primary | Specifies the color of the link |
fontWeight | LinkFontWeight | regular | Specifies the font weight of the link |
icon | Code | - | Adds an icon next to the link text |
This component inherits all native anchor properties. Learn more.
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.
link
└── dist
├── index.d.ts <-- Types
├── index.js <-- CommonJS version
└── index.mjs <-- ES Modules version
...
Versioning
Follows semantic versioning
© License
Licensed under MIT License