Backdrop Package

Backdrops can be used when an application is being loaded or when the user opens a modal.

Backdrop Usage

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

export const App = () => {
  return (
    <Backdrop>
      <div>Children here</div>
    </Backdrop>
  );
};

API

Backdrop

This component can contain a ReactNode as a centrilized child.

| Property | Type | Default | Description | | ------------ | -------------------- | -------- | ----------------------------------------------------- | | isOpen | boolean | false | Defines if the backdrop is being shown or not | | type | enum<BackdropType> | dark | Sets the Backdrop opacity given the available options | | children | ReactNode | - | Child components to be rendered | | dataTestId | string | backdrop | Backdrop test identifier |

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.

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

Versioning

Follows semantic versioning

© License

Licensed under MIT License