React Webpage Essentials

A collection of modules, components and helpers to kickstart a react webpage.

Installation

npm i @feierstoff/react-webpage-essentials

For local usage use

npm link @feierstoff/react-webpage-essentials  

Usage

Structure

The package is structured into modules. You can access the components and functions by importing them directly from the needed module:

import {...} from "@feierstoff/react-webpage-essentials/module";

Providers

Wrap the ThemeProvider delivered by the @mui/material package around the FullProvider component to make all functionalities accessible.

import { ThemeProvider } from "@mui/material";
import { FullProvider } from "@feierstoff/react-webpage-essentials";

// See docs
import theme from "./theme";
import navigation from "./navigation";
import routes from "./routes";

const Root = (): JSX.Element => {
    return (
        <ThemeProvider theme={theme}>
            <FullProvider navigation={navigation} routes={routes} routerType="hash"/>
        </ThemeProvider>
    );
}

Theme, Routes, Navigation

Look at the routes, theme and navigation modules in the documentation to set up the Provider correctly.

Documentation

Check out the documentation to learn how to use every module of this package.