๐Ÿš€ Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more โ†’

optimizely-oui

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

optimizely-oui

Optimizely's Component Library.

49.0.0
latest
78

Supply Chain Security

100

Vulnerability

92

Quality

83

Maintenance

80

License

Version published
Weekly downloads
242
20.4%
Maintainers
6
Weekly downloads
 
Created

Axiom Component Library

A custom CSS framework and React component library that powers the Optimizely user interface.

Build Status codecov npm version

๐Ÿ“ฆ Installation

npm install optimizely-oui
yarn add optimizely-oui

สฆ TypeScript

Typescript types are generated for src/components from their JS files to aid consumption of this repo in Typescript. The optimizely-oui declaration file (types/templates/module-declaration.d.ts) exports all named component exports. To build the exported declaration file (types/index.d.ts), the autogenerated individual component module declarations are merged with the main declaration file (see yarn generate-types).

PropTypes

PropTypes can still be used for non-Typescript (.js) components as well as when more complex validation is needed. The (babel-plugin-typescript-to-proptypes)[https://www.npmjs.com/package/babel-plugin-typescript-to-proptypes] plugin is used to ensure that all components (typed or not) are exported with PropTypes.

๐Ÿ’ช Contribute

Read how to contribute to Axiom for instructions on making pull requests.

๐Ÿšข Release

Check out the Release a New Version section for instructions on releasing a new version of Axiom.

โšก๏ธ React

To use an Axiom component inside your React app:

import React from 'react';
import { Button } from 'optimizely-oui';
...
return ( <Button size="tiny">Click Me</Button> );

๐Ÿงช Testing

Thanks to Chromatic, Axiom runs visual regression tests on every pull request and merge. These tests are snapshots of each Storybook story within the repository. For implementation details, see the Chromatic section of the contributing guidelines.

๐Ÿ’… Sass

To use Axiom Sass variables and mixins in your project read how to use Axiom sass.

FAQs

Package last updated on 24 Sep 2021

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