0.1.0 • Published 6 years ago

material-ui-not-found v0.1.0

Weekly downloads
1
License
MIT
Repository
github
Last release
6 years ago

material-ui-not-found

Material-UI NotFound

'Resource Not Found' component for React integrated with material-ui package.

Requirements

  • React 16.2.0 (not tested on other versions)
  • Material-UI 0.20.0 (not tested on other versions)

Required Knowledge

I recommend that you get to know React and Material-UI.

Installation

npm i material-ui-not-found --save

or

yarn add material-ui-not-found

Usage

Once installed, just import and use the component:

import React from 'react';
import {NotFound} from 'material-ui-not-found/NotFound';

const className = 'custom-class';
const style = {
  width: '50%',
};

export const Example = () => (
  <NotFound
    className={className}
    style={style}
    text={'Unknown resource.'}
  />
);

export default Example;

Properties

PropsOptionsDefaultDescription
classNameString''Adds custom class to component wrapper.
styleObject{}Adds custom inline styles to component wrapper.
textString'Page was not found.'Replaces default text 'Page was not found.' with custom.

Contribute

  1. Submit an issue
  2. Fork the repository
  3. Create a dedicated branch (never ever work in master)
  4. The first time, run command: yarn into the directory
  5. Fix bugs or implement features

Future

  • Add tests
  • Add examples

License

This project is licensed under the terms of the MIT license