@lokalise/louis

Louis

Welcome to Louis. This project, built by Lokalise, is a ReactJS implementation of the Louis Design System. It contains the core components to start building your React application with Lokalise's look and feel.

Check Louis production storybook and figma ui library.

Prerequisites

Make sure your application bundler (e.g. Webpack) does have a loader (e.g. style-loader) for bundling CSS files.

Installation

To use Louis in your project, run the following command in your terminal:

npm i @lokalise/louis

After installing Louis, you need to set up a ThemeProvider at the root of your application:

import { ThemeProvider, themes } from '@lokalise/louis';

const App = () => (
	<ThemeProvider theme={themes.light}>
		<TheRestOfYourApplication />
	</ThemeProvider>
);

From here on out, you can import and use Louis components anywhere:

import { Button } from '@lokalise/louis';
import { useState } from 'react';

export const MyCounter = () => {
	const [count, setCount] = useState(0);
	return (
		<>
			<p>{`You've clicked the button ${count} times!`}</p>
			<Button variant="primary" onClick={() => setCount(count + 1)}>
				Click to increase the counter
			</Button>
		</>
	);
};

Reporting issues

You can report issues on our JIRA Project, reach us on Slack or submit a Support Request.

How to contribute

Check our guidelines here

Code of Conduct

Follow up on our code of conduct

Thanks

Louis relies heavily on some of the approaches provided by Chakra-UI and Reach UI.

License

This project is APACHE, VERSION 2.0 licensed.