WorkXero Design System - Components React

WorkXero Design System is a component library designed to help developers create the best experience for software or services distributed by WorkXero Platforms. Visit the WorkXero Design System to learn more.

Using the WorkXero Design System

Installation

Run the following command using npm:

npm install @workxero/design-react

If you prefer Yarn, use the following command instead:

yarn add @workxero/design-react

Usage

After adding the @workxero/design-react package to your project, you've to extend the standard React setup by the WorkXeroDesignSystemProvider.

// index.tsx

import ReactDOM from 'react-dom';
import { WorkXeroDesignSystemProvider } from '@workxero/design-react';
import './index.css';
import { App } from './App';

ReactDOM.render(
  <React.StrictMode>
    <WorkXeroDesignSystemProvider>
      <App />
    </WorkXeroDesignSystemProvider>
  </React.StrictMode>,
  document.getElementById('root')
);

Change your App file to use at least one WorkXero Design System component, for example:

// App.tsx

import { Button } from '@workxero/design-react';

export const App = (): JSX.Element => (
  <div className="App">
    <Button>Some label</Button>
  </div>
);

Methodology

Our goal is to provide easy-to-use and well-documented components so that developers don’t need to worry about the implementation but can focus on easily creating qualitative and consistent digital WorkXero experiences. We ensure that our components are made for everyone and meet latest quality standards of usability, accessibility, performance and compatibility. In some points the components are built restrictive to define consistent standards for diverse WorkXero applications but ensure enough flexibility to meet different context requirements.

License

• See Custom License within npm package