app-arena/patterns

App-Arena Styleguide and pattern library based on patternlab.io

Installs: 620

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 6

Forks: 4

Open Issues: 0

Language:JavaScript

Type:project


README

npm package PeerDependencies Dependencies DevDependencies Coverage Status Build Status semantic-release

App-Arena Patterns is a set of React components that implement the App-Arena CI.

Title Description
Pattern demos Demo of all patterns of this library.
Contributing Creating and publishing new patterns or editing the Brand portal.
Pattern generator How the Yeoman pattern generator works and how it can be edited.

Getting started

App-Arena Patterns are available as npm package.

yarn add apparena-patterns-react

or

npm install apparena-patterns-react

to add all components to your app.

Usage

Here is a quick example to get you started:

./App.js

import React from 'react';
import ReactDOM from 'react-dom';
import MyAwesomeReactComponent from './MyAwesomeReactComponent';

const App = () => (
    <MyAwesomeReactComponent />
);

ReactDOM.render(
  <App />,
  document.getElementById('app')
);

./MyAwesomeReactComponent.js

import React from 'react';
import {Button} from 'apparena-patterns-react';

const MyAwesomeReactComponent = () => (
  <Button type="primary">Label</Button>
);

export default MyAwesomeReactComponent;

Please refer to each component's documentation page to see how they should be imported.

Contributing

If you would like to contribute patterns or add patterns to this library, head over to our contributing section.

License

This project is licensed under the terms of the MIT license