Skip to content

amadeuszblanik/bme-ui

Repository files navigation

BME-UI

Beta releases

Links

License

MIT

Installation

Use the package manager npm or yarn to install BME-UI.

yarn add bme-ui@beta

npm install --save bme-ui@beta


## Usage
```typescript
import React from 'react';
import { BmeText } from 'bme-ui';

const Foo: React.FunctionComponent = () => <BmeText>Hello world</BmeText>

export default Foo;

More about usage: storybook

Theme Provider

import { ThemeProvider } from "styled-components";
import { BmeTest } from "bme-ui";
import dark from "bme-ui/dist/themes/dark";
import type { AppProps } from "next/app";

function App({ Component, ...rest }: AppProps) {
  return (
      <ThemeProvider theme={dark}>
        <BmeTest variant="primary" />
        <Component {...props.pageProps} />
      </ThemeProvider>
    );
}

export default App;

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT

Credits

*leungwensen/svg-icon