HermesGermany/last-mile-components

UI Components for the Last Mile

Last Mile Components

This is a library of reusable React components for building web apps for the last-mile.

Installation

To install the library in your app, simply run:

# npm
npm install @hermesgermany/last-mile-components

# yarn
yarn add @hermesgermany/last-mile-components

Afterwards, import the components styles either in your CSS

@import "@hermesgermany/last-mile-components/dist/style.css";

or in the root of your application by omitting the @ in the import directive. You're good to go!

Usage

To use a component in your app, import it from the library:

import { BurgerMenu, Popover } from "@hermesgermany/last-mile-components"

function MyComponent() {
  return (
    <BurgerMenu>
      <Popover.MenuGroup groupLabel="Settings">
        <Popover.MenuItem
          label="User Settings"
          action={() => console.log("user settings")}
        />
        <Popover.MenuItem
          label="Dev Settings"
          action={() => console.log("dev settings")}
        />
      </Popover.MenuGroup>
    </BurgerMenu>
  )
}

Storybook documentation

You can see the latest version of our documentation here: LMC Docs

To view the components locally, you can launch Storybook by following these steps:

npm install
npm run dev

License

This library is licensed under the MIT licence. See 'LICENSE' for more information.