Skip to content

Commit

Permalink
docs() add more documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
RomuloCintra committed Jan 22, 2018
1 parent ccb8ee2 commit e623471
Showing 1 changed file with 44 additions and 4 deletions.
48 changes: 44 additions & 4 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,53 @@



# o-content-placeholder
# o-content-placeholder [Demo](https://o-rango.github.io/o-content-placeholder/)
Simple and customizable content placeholder built as web component with Stenciljs :metal:
## Getting Started

### Simple and customizable content placeholder built as web component with Stenciljs :metal:
To try this component:

```bash
npm i --save @o-rango/o-content-placeholder
```


### Demo Version [Demo](https://o-rango.github.io/o-content-placeholder/);
![](./skeleton-placeholder.gif)
```html

// Add script tag to your page

<script src="./node_modules/@o-rango/orango-demo-tools/dist/o-content-placeholder.js.js"></script>
// OR
<script src="https://unpkg.com/@o-rango/orango-demo-tools/dist/o-content-placeholder.js.js"></script>
```

And compose your content placeholder with `<o-content-placeholder-img>` or `</o-content-placeholder-block>`

```html
<o-content-placeholder-img size="55" animate="true" format="square"></o-content-placeholder-img>
<o-content-placeholder-block rounded="true" line-height="15" margin="6" animate="true" lines="3"></o-content-placeholder-block>
<o-content-placeholder-img size="55" animate="false" format="circle"></o-content-placeholder-img>
```


Properties

```html

//o-content-placeholder-block
@Prop() animate: boolean = false;
@Prop() lines: number = 1;
@Prop() lineHeight: number = 15;
@Prop() margin: number = 5;
@Prop() randomSize: boolean = false;
@Prop() rounded: boolean = false;

//o-content-placeholder-img
@Prop() animate: boolean = false;
@Prop() format: 'circle' | 'square' = 'square';
@Prop() size: number = 55;

```

### Demo Version
![](./skeleton-placeholder.gif)

0 comments on commit e623471

Please sign in to comment.