https://github.com/availity/element

React components for the Availity design system Element
https://github.com/availity/element

Last synced: about 1 month ago
JSON representation

React components for the Availity design system Element

• Host: GitHub
• URL: https://github.com/availity/element
• Owner: Availity
• License: mit
• Created: 2023-01-10T15:33:50.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-11-06T20:07:08.000Z (about 2 months ago)
• Last Synced: 2024-11-06T21:53:17.422Z (about 2 months ago)
• Language: TypeScript
• Homepage: https://availity.github.io/element/
• Size: 276 MB
• Stars: 3
• Watchers: 6
• Forks: 1
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# availity-element

✨ **This workspace has been generated by [Nx, a Smart, fast and extensible build system.](https://nx.dev)** ✨

This is a collection of reusable React components intended to be used across multiple projects. These components use [@availity/design-tokens](https://github.com/Availity/element/tree/main/packages/design-tokens#readme) for styling and [Material UI](https://mui.com/) as the base.

Visit our [documentation site](https://zeroheight.com/2e36e50c7/p/77f9e0-components) for more information on how to use the components.

## Installation

To install the library in your project, you can use either NPM or Yarn:

```sh

npm install @availity/element

```

OR

```sh

yarn add @availity/element

```

## Usage

The [@availity/element](https://availity.github.io/element/?path=/docs/element--docs) package contains all of the components and hooks for the design system. We recommend using this package when you want to use multiple components.

To use the components in your project, you will need to import them first:

```tsx

import { Button, ThemeProvider } from '@availity/element';

```

Make sure all of the components you use are inside the `ThemeProvider` component. We recommend placing it in your root `index.{js|tsx}` file.

```jsx

import { ThemeProvider } from '@availity/element';

const App = () => {

  return {/* Application code. Most likely a router. */};

};

```

## Development

The currently recommended version of node to use when developing in this repo is: `v20`. We recommend using [fnm](https://github.com/Schniz/fnm#readme) to have your node version automatically changed when you `cd` into the repo.

We use `yarn berry` (aka yarn v3) to manage dependencies. Install `yarn` globally:

```sh

npm i -g yarn

```

> This command will install yarn v1. When we run the next command then yarn v3 will be added.

Then install the dependencies:

```sh

yarn install

```

If you want to see the components in action as you develop then run the `storybook` server as you code

```sh

yarn start:storybook

```

Want to make sure you didn't break anything? Run the unit test script

```sh

yarn test

```

## Further help

Visit the [Nx Documentation](https://nx.dev) to learn more.