Socket
Socket
Sign inDemoInstall

@button-inc/component-library

Package Overview
Dependencies
89
Maintainers
6
Versions
16
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @button-inc/component-library

Library for theme-able, accessible, progressively-enhancing react components


Version published
Maintainers
6
Created

Readme

Source

Component Library

Contents

  • Overview
  • Getting Started
  • Usage
  • Components

Overview

This package is a library of react components focused on accessibility and progressive enhancement. When used with a server-side-rendered react application, these components remain functional for users who may not have javascript or css available.

Getting Started

Install the package:

  • npm i @button-inc/component-library or yarn add @button-inc/component-library

Import component(s):

  • import Button from @button-inc/component-library/Button

For themed components, you can add @button-inc/bcgov-theme or @button-inc/button-theme.

If you want to build your own theme, see Here for instructions. There is also a live playground to test it out.

Components

For a list of components and their properties, see Components

Update documentation

To keep the documentation easy to update, the core components information is located in the docs section of the root of this repository, in the file components.js. After updating information, from the root directory run make document-components to update across the storybook instance and this readme.

FAQs

Last updated on 13 Oct 2022

Did you know?

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

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc