Accordion Package

An accordion is a vertically stacked list of headers that reveal or hide associated sections of content.

Accordion Usage

import { Accordion } from '@dt-dds/react';

export const App = () => {
  const headerCustomContent = <>Header content here.</>;

  return (
    <Accordion headerContent={headerCustomContent}>
      Body content here.
    </Accordion>
  );
};

Properties

| Property | Type | Default | Description | | ----------------- | --------------------- | ------------------- | ----------------------------------------------------------- | | isOpen | boolean | false | Boolean value to define if the accordion is open or closed | | hasBackground | boolean | false | Sets the Accordion background color | | headerContent | ReactNode | - | Child component to be rendered on the accordion header | | isDisabled | boolean | false | Boolean value to define if the Accordion is disabled or not | | children | ReactNode | - | Child component to be rendered on the accordion body | | dataTestId | string | accordion-container | Accordion test identifier | | style | React.CSSProperties | - | Gives the Accordion CSS properties | | hasBorderBottom | boolean | false | Sets the Accordion border-bottom |

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 package
• yarn dev - Run the package locally
• yarn lint - Lint all files within this package
• yarn test - Run all unit tests
• yarn test:report - Open the test coverage report
• yarn 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.

accordion
└── dist
    ├── index.d.ts  <-- Types
    ├── index.js    <-- CommonJS version
    └── index.mjs   <-- ES Modules version
    ...

Versioning

Follows semantic versioning

© License

Licensed under MIT License