@woven-planet/lakefront v5.5.3

lakefront

Lakefront is a simple React component library.

Installation

Lakefront is available as an npm package.

// with npm
npm install @woven-planet/lakefront

// with yarn
yarn add @woven-planet/lakefront

Emotion's ThemeProvider must wrap your application for the components to style correctly.

import { ThemeProvider } from '@emotion/react';
import { theme } from '@woven-planet/lakefront';

<ThemeProvider theme={theme}>
    ...
</ThemeProvider>

Usage

⚠️ LakeFront requires the client application to use React 18 as well as Node 18.x. ⚠️

Here is a quick example to get you started, it's all you need:

import { createRoot } from 'react-dom/client';
import { Button } from '@woven-planet/lakefront';

function App() {
    return <Button>Hello World</Button>;
}

createRoot.render(<App />, document.querySelector('#app'));

Contributing

If you want to contribute to the action, even by just raising a problem or proposing an idea, you can click here to find out how to do it.

Storybook Components

We've added Storybook pages to show how each component can be used.

How to add components to this table

Upon a new component being added to this table run 'npm run update-readme' for boilerplate code. Please replace the three variables with the corresponding information as needed. Also, store screenshots of components in the 'screenshots' folder.

Please do not add information below this table, the 'npm run update-readme' will not work properly if the table is not last.