RM Components

This is a work in progress component library.

Styleguide: https://xalgo-rm-component-styleguide.netlify.app/

Sample app: https://xalgo-rm-components-sample-application.netlify.app/

Usage

# Using yarn
$ yarn add @xalgorithms/rm-components@latest

# Using npm
$ npm i @xalgorithms/rm-components@latest

Within your application, you can now import and use the components:

import { Text, Input, Label } from "@xalgorithms/rm-components";

<Text variant={"heading"}>Slide Me!</Text>
<Input variant={"secondary"} type={"range"} />

Development

# Install packages
yarn install

# View the styleguide (styleguidist)
yarn start

# Run testing React app
yarn react-start

You can also use npx styleguidist server to run styleguidist directly.

Often we'll need to bump the version of the dependency xalgo-rule-processor with:

yarn upgrade xalgo-rule-processor@latest

# Or to upgrade everything
yarn upgrade --latest

Publishing

Contributors must request access to the @xalgorithms npm organization to publish the package.

npm login
npm publish --access public