lq-react-components
v0.0.15
Published
!use only after 0.0.14
Downloads
10
Readme
lq-react-components
!use only after 0.0.14
Install
npm install --save lq-react-components
or
yarn add lq-react-components
Usage
import React, { Component } from 'react';
import {NotImplemented} from 'lq-react-components';
class Example extends Component {
render() {
return <NotImplemented />;
}
}
Header - this component does not have the required props but you can use the following props to customize this component:
logoHref: PropTypes.string
- Path used after click on the Header logo image, by default to '/'.logoImg: PropTypes.string
- Path of logo image for the Header, by default used image from library, which is located '/src/images/logo.png'.
You can use only one of the Header body component: Menu or Title, if you send both, the Header menu will be ignored and used only the Title, by default the Header does not display either Title or Menu
title: PropTypes.string
- Title of the HeadermenuItems: PropTypes.array
- Array of object, like:
{ title: 'Users', # The title for this menu item url: '/users', # Path used after click on this menu item icon: 'user-circle' # name for icon for this menu item, used font-awesome (fa fa-`${your_name}`) }
isActiveMenuItem: PropTypes.func
- Function that return bool value, that mean active this menu item or not, by default falseonMenuItemClick: PropTypes.func
- Function that used after menu item clickisLogin: PropTypes.bool
- Boolean value, that mean show User Menu or not, by default falseonSingOut: PropTypes.func
- Function that use after click on User Menu 'Sign out' itemloginEl: PropTypes.element
- Shown only ifisLogin = false
, the element that shown in right side instead of User Menu when user not authorized, by default not showing
License
MIT © [Evgeniya Zaikina](https://github.com/Evgeniya Zaikina)