README.md

RMUI Big Components

A React big components library using Material UI.

Big components are components that are composed of other components. They are not atomic components.

The approach is to create components that are easy to use and quickly integrated, you just need to pass the props and the component will do the rest.

Quick start

To display a simple footer like this:

You have to do this:

import { Footer } from 'rmui-bigcomponents';

function App() {
    return (
        <Footer
            copyrightText="Website. All rights reserved."
            socialMediaLinks={[
                { name: 'facebook', url: '#' },
                { name: 'twitter', url: '#' },
                { name: 'instagram', url: '#' }
            ]}
            subLinks={[
                { name: 'Contact Us', url: '#' },
                { name: 'About Us', url: '#' },
                { name: 'Privacy Policy', url: '#' },
                { name: 'Terms of Use', url: '#' }
            ]}
        />
    );
}

Documentation

The documentation is available here.