Socket
Socket
Sign inDemoInstall

@bolttech/atoms-description-wrapper

Package Overview
Dependencies
Maintainers
8
Versions
31
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@bolttech/atoms-description-wrapper

A React component for displaying descriptions with optional icons and styling options.


Version published
Weekly downloads
259
decreased by-28.25%
Maintainers
8
Weekly downloads
 
Created
Source

DescriptionWrapper Component

A React component for displaying descriptions with optional icons and styling options.

Installation

Use the package manager npm or yarn to install the component.

npm install @edirect/frontend-foundations @bolttech/atoms-description-wrapper

or

yarn add @edirect/frontend-foundations @bolttech/atoms-description-wrapper

Props

The DescriptionWrapper component accepts the following properties:

PropTypeDescription
coverageLabelstringThe label for the coverage description.
coverageValuestringThe value to be displayed in the description.
sizeVariantstringThe size variant of the component (e.g., 'small', 'medium', 'large').
iconstringThe name of the icon to be displayed next to the description.
breakLinebooleanIf true, the description will break to a new line if necessary.
includedbooleanIf true, the component is considered included.
dataTestIdstringThe data-testid attribute for testing.

Usage

import React from 'react';
import {DescriptionWrapper} from '@bolttech/atoms-description-wrapper';
import {bolttechTheme, BolttechThemeProvider} from "@edirect/frontend-foundations";

const ExampleComponent = () => {
  return (
    <BolttechThemeProvider theme={bolttechTheme}>
      <DescriptionWrapper
        coverageLabel="Coverage"
        coverageValue="Included"
        sizeVariant="small"
        icon="check_circle"
        breakLine={false}
        included={true}
        dataTestId="custom-description"
      />
    </BolttechThemeProvider>
  );
};

export default ExampleComponent;

Contributing

Contributions are welcome! For any bug fixes, improvements, or new features, please open an issue or submit a pull request.

Please make sure to follow the code standards and test your changes before submitting.

FAQs

Package last updated on 05 Sep 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc