Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
docs(prop): baseurl
  • Loading branch information
danilowoz committed Mar 7, 2019
commit 333b04ea24211314d1eab74ca5a20a39de661545
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,10 @@ Defaults to `true`. Opt-out of animations with `false`

Defaults to `Loading interface...`. It's used to describe what element it is. Use `false` to remove.

**`baseUrl? string`**

Required if you're using `<base url="/" />` in your `<head/>`. Defaults to an empty string. This prop is commom used as: `<ContentLoader baseUrl={window.location.pathname} />` which will fill the svg attribute with the relative path. Related [#93](https://github.com/danilowoz/react-content-loader/issues/93).

**`speed?: number`**

Defaults to `2`. Animation speed in seconds.
Expand Down
8 changes: 8 additions & 0 deletions docs/props.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,14 @@ Defaults to `Loading interface...`. It's used to describe what element it is. Us
<Facebook ariaLabel="my custom loader" />
</Playground>

## **`baseUrl? string`**

Required if you're using `<base url="/" />` in your `<head/>`. Defaults to an empty string. This prop is commom used as: `<ContentLoader baseUrl={window.location.pathname} />` which will fill the svg attribute with the relative path. Related [#93](https://github.com/danilowoz/react-content-loader/issues/93).

<Playground>
<Facebook baseUrl="/mypage" />
</Playground>

## `speed?: number`

Defaults to `2`. Animation speed in seconds.
Expand Down