Skip to content

bruegmann/blue-react

Repository files navigation

React component library based on Bootstrap

Blue React

npm version

Checkout the docs to find out how to use Blue React.

Breaking changes between v9 and v10

Removed hash router from Layout

The new Layout no longer has a hash router. So there is no pages prop anymore. The router moved to its own component HashRouter for legacy reasons. But it's recommended to use other solutions like React Router or TanStack Router.

Move side content to side prop

It should look like this:

<Layout
    side={
        <SidebarMenu>
            <MenuItem href="." label="Home" />
        </SidebarMenu>
    }
>
    Your page content
</Layout>

Removed HTML elements for status

If you use util functions for status like showSuccess() or setAlertMessage() you need to embed the Status React component like this:

<Status
    dangerIcon={<XCircleFill />}
    infoIcon={<InfoCircleFill />}
    successIcon={<CheckCircleFill />}
    warningIcon={<ExclamationCircleFill />}
/>

Developing

This project is built with CRA. To start developing, just and install everything with npm i and run:

npm start

Create a new release

This is how to manually create a release:
By running

npm publish

the missing files in ./dist will be created, the docs will be generated and the NPM package will be released.

To publish changes on the documentary, run:

npm run deploy

To run both of them:

npm run release