TomSlezakowski / react-ui

Repository for public react components in Jam3

Home Page:https://jam3.github.io/react-ui/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Jam3 React UI stable

Repository for public react components in Jam3. These components are used out of the box in the Jam3 SPA Generator

Component Library

https://jam3.github.io/react-ui/

Installation

@Jam3/React-UI is available as an npm package

NPM

npm install @jam3/react-ui
yarn add @jam3/react-ui

Basic Usage

import React from 'react';
import { BaseLink } from '@jam3/react-ui';

Eject Usage

The components in this library can be ejected for advanced customization while maintaining version control. This functionality is achieved by npm post install hook that runs src/scripts/copy-component-utility.js To use it, simply define some react-ui specific properties at the bottom of your project's local package.json.

"react-ui": {
  "eject": true,
  "eject-path": "./src/components",
  "components": [
    "BaseButton",
    "VideoPlayer"
  ]
}

eject: Enables the ejection of components, if ommited the script will not be called. eject-path: Specifies a custom path for the components to be ejected to, if ommited defaults to src/components. components: A list of components to eject into your project.

For more information, please refer to Usage in our documentation.

Contributing

Please make sure to read the contributing guide before making a pull request.

Changelog

Detailed changes for each release are documented in the release notes.

Licence

@jam3/react-ui is open source and released under the MIT Licence.

About

Repository for public react components in Jam3

https://jam3.github.io/react-ui/

License:MIT License


Languages

Language:JavaScript 79.9%Language:SCSS 15.7%Language:HTML 4.5%