@praharsh/react-cleverprogrammer v1.0.6
@praharsh/react-cleverprogrammer
Use the cool clever programmer UI components in your react project
Install
npm install --save @praharsh/react-cleverprogrammer
yarn add @praharsh/react-cleverprogrammer
Simple Example
Here is a quick example to get you started, it's all you need :
import React from 'react'
import { Button } from '@praharsh/react-cleverprogrammer'
import '@praharsh/react-cleverprogrammer/dist/index.css'
const CleverProgrammerComponent {
return (
<Button>
React is 🔥
</Button>
)
}
Demo
A quick demo can be found here demo 🔥
Components
This package has a few components, other will be added in the future 🤩
- Navbar
- Avatar
- Button
- Input
USAGE
<Navbar>
This will create a navigation bar with a brand/logo section and a links section
Props
imgSrc
If you want a custom image logo you can pass the link(which points to a image). If the link doesn't point an image then the default Brand text will appear
<Navbar imgSrc='<LINK_TO_LOGO>' />
component
If you want only text or any other custom component to appear instead of the image you should pass a valid react component to this prop
<Navbar component={<h1>My Brand Name</h1>} />
or
<Navbar component={<MyLogoComponent />} />
sticky
The navigation bar can be sticky if you pass the sticky prop
<Navbar sticky />
children
To have some links in the navigation bar you should pass those elements as children, i.e., wrap them inside Navbar component
<Navbar component={<h1>My Brand Name</h1>}>
<li>About</li>
<li>Careers</li>
<li>Contact</li>
<a>Sign in</a>
</Navbar>
<Button>
The example for how to use this component is shown under SIMPLE EXAMPLE
above ☝🏼
Props
children
The content that is passed between the button tags are children. By default the content inside the button would be Clever Programmer
, to change this you need to pass something like
<Button>Hello Guys!!</Button>
type
By, default the type for the button is button
. You can change this by passing the type attribute
<Button type='submit'>Login</Button>
You can even pass the event listeners to the button component. For example:
<Button onClick={doSomething}>{counter}</Button>
<Avatar />
Props
src
This is the only this component needs, which will be an image link. If this is not passed then the default profile picture will be the clever programmer's logo 😋
<Avatar src='<LINK_TO_IMAGE>' />
<Input />
Props
type
This component only works for input types like text, email, and password
. By default the type is text
<Input type='text || email || password' />
variant
This will determine how the input bar is styled
default
By default the variant is default
<Input variant='default' />
rounded
This will give you a rounded input bar
<Input variant='rounded' />
bordered
A input bar with a bottom border is rendered
<Input variant='bordered' />
label
If you want to have some text inside the input before user types (like placeholder!) you can pass it in the label
<Input label='Username' />
<Input label='Email' />
You can also pass the
value
onChange
required
props if needed
License
MIT © Praharsh99