Skip to content

Commit

Permalink
updated README.md to add links to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mrsaeeddev committed Jan 22, 2020
1 parent 0faaf66 commit 21f542e
Showing 1 changed file with 6 additions and 158 deletions.
164 changes: 6 additions & 158 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,164 +14,12 @@ npm install --save neumorphic-ui

### Components

#### - NeuHeading
NeuHeading is a component by which you can put interactive headings in your web pages.

###### Props
This component accepts 3 props:
1. ```text``` - text which you want as a heading
2. ```fontSize``` - font-size of heading (in px)
3. ```fontWeight``` - font-weight of heading

```jsx
import { NeuHeading } from 'neumorphic-ui';

class Example extends Component {
render () {
return (
<NeuHeading text="Neumorphic UI" fontSize="128px" fontWeight="900" />
)
}
}
```

#### - NeuButton
NeuButton is a component which is equivalent to Button component in other libraries.

###### Props
This component accepts 1 prop:
1. ```text``` - text which you want as text in button
2. ```hovered``` - this prop accepts a boolean value
3. ```clicked``` - this prop accepts a boolean value
4. ```mouseOver``` - this prop accepts a function
5. ```mouseOut``` - this prop accepts a function
6. ```onClick``` - this prop also accepts a function

```jsx
import { NeuButton } from 'neumorphic-ui';

class Example extends Component {
constructor(props){
super(props);
this.state = {
hovered: false,
clicked: false
}
}

onClick = () => {
this.setState({ hovered:false, clicked: !this.state.clicked }); }

mouseOver = () => {
!this.state.clicked && this.setState({hovered:true})
}

mouseOut = () => {
this.setState({hovered: false})
}

render () {
return (
<NeuButton hovered={this.state.hovered} clicked={this.state.clicked} onClick={this.onClick} mouseOver={this.mouseOver} mouseOut={this.mouseOut} text="Neumorhpic Button" />
)
}
}
```

#### - NeuCard
NeuCard is a component which is equivalent to Card component in other libraries.

###### Props
This component accepts 3 props:
1. ```children``` - This represents children of Card. You do not need
to pass this prop explicilty to ```NeuCard``` component. Instead just wrap
child components in ```NeuCard``` opening and closing tags.
2. ```width``` - width of the card (px or percentages)
3. ```height``` - height of the card (px or percentages)

```jsx
import { NeuCard } from 'neumorphic-ui';

class Example extends Component {
render () {
return (
<NeuCard width="350px" height="320px">
...Child components
</NeuCard>
)
}
}
```

#### - NeuInput
NeuInput is a component which you can use as an input field.

###### Props
This component accepts 4 props:
1. ```width``` - width of input field (in px or %)
2. ```placeholder``` - placeholder value of input field
3. ```value``` - value of input field
4. ```onChange``` - function which you want to pass to interact with changes in input field

```jsx
import { NeuInput } from 'neumorphic-ui';

class Example extends Component {
constructor(props){
super(props);
this.state = {
value: ""
}
}

render () {
return (
<NeuInput width="96%" onChange={e => this.setState({value:e.target.value})} placeholder="Neumorphic Input" value={this.state.value} />
)
}
}
```

#### - NeuProgressBar
NeuProgressBar is a component which you can use as a progress bar.

###### Props
This component accepts 1 prop:
1. ```progress``` - progress of input field (in %)

```jsx
import { NeuProgressBar } from 'neumorphic-ui';

class Example extends Component {
render () {
return (
<NeuProgressBar progress="80%" />
)
}
}
```

#### - NeuReaction
NeuReaction is a component which you can use as a reaction button.

###### Props
This component accepts 2 props:
1. ```size``` - size of reaction button (in px)
2. ```children``` - This represents children of NeuReaction component. You do not need
to pass this prop explicilty to ```NeuReaction``` component. Instead just wrap
child components in ```NeuReaction``` opening and closing tags.

```jsx
import { NeuReaction } from 'neumorphic-ui';

class Example extends Component {
render () {
return (
<NeuReaction ><img src={like} width="30px" height="30px"></NeuReaction>
)
}
}
```
- [NeuButton](https://neumorphic-ui.netlify.com/neubutton "NeuButton")
- [NeuCard](https://neumorphic-ui.netlify.com/neucard "NeuCard")
- [NeuHeading](https://neumorphic-ui.netlify.com/neuheading "NeuHeading")
- [NeuProgressBar](https://neumorphic-ui.netlify.com/neuprogressbar "NeuProgressBar")
- [NeuReaction](https://neumorphic-ui.netlify.com/neureaction "NeuReaction")
- [NeuInput](https://neumorphic-ui.netlify.com/neuinput "NeuInput")

## Feedback
Suggestions and contributions are welcome. If you can by any means improve the library, just reach out to me at anyone of my social media platforms. Also, you can email me at : [email protected]
Expand Down

0 comments on commit 21f542e

Please sign in to comment.