Skip to content

Commit

Permalink
Document usage of the three components
Browse files Browse the repository at this point in the history
  • Loading branch information
Kristofer Selbekk committed Dec 18, 2017
1 parent 5ea3ee4 commit 59e1038
Show file tree
Hide file tree
Showing 6 changed files with 45 additions and 4 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Changelog

## v.2.0.3
## v.2.0.4
* Document and refactor internally.
* Deprecate `text` prop in favor of `children`

Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "ffe-spinner-react",
"version": "2.0.3",
"author": "Sparebank 1",
"version": "2.0.4",
"author": "SpareBank 1",
"main": "lib/index.js",
"scripts": {
"build": "babel -d lib/. --ignore=*.test.js src/.",
Expand Down
8 changes: 8 additions & 0 deletions src/InlineSpinner.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Inline spinner

Brukes inline med tekst eller små komponenter for å vise at man venter på ekstern data. Et
eksempel kan være en nedtrekksliste som henter valgene sine fra en server.

```js
<InlineSpinner /> Vennligst vent litt
```
8 changes: 8 additions & 0 deletions src/LargeSpinner.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Stor inline spinner

Brukes med større komponenter for å vise at man venter på ekstern data. Et
eksempel kan være en graf som venter på data fra en server før den kan rendres.

```js
<LargeSpinner>Vennligst vent litt</LargeSpinner>
```
2 changes: 1 addition & 1 deletion src/Spinner.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import React from 'react';
import { bool, node } from 'prop-types'
import { bool, node } from 'prop-types';

const Spinner = ({ text, children, large = false, center = true }) => (
<div className={ `ffe-content-container ${ !center ? 'ffe-content-container--text-left' : '' }` }>
Expand Down
25 changes: 25 additions & 0 deletions src/Spinner.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Spinner

En selvstendig komponent for å vise at man venter på innholdet siden avhenger av.

```js
<Spinner />
```

Den kan ha en tekst under seg som forklarer ventetiden:

```js
<Spinner>Kalkulerer pris...</Spinner>
```

Den kan være venstrestilt:

```js
<Spinner center={false/>
```

Den kan være stor:

```js
<Spinner large={true} />
```

0 comments on commit 59e1038

Please sign in to comment.