From 59e10383d682d11140dcdb43e8a712baeedf6c64 Mon Sep 17 00:00:00 2001 From: Kristofer Selbekk Date: Thu, 14 Dec 2017 15:41:54 +0100 Subject: [PATCH] Document usage of the three components --- CHANGELOG.md | 2 +- package.json | 4 ++-- src/InlineSpinner.md | 8 ++++++++ src/LargeSpinner.md | 8 ++++++++ src/Spinner.js | 2 +- src/Spinner.md | 25 +++++++++++++++++++++++++ 6 files changed, 45 insertions(+), 4 deletions(-) create mode 100644 src/InlineSpinner.md create mode 100644 src/LargeSpinner.md create mode 100644 src/Spinner.md diff --git a/CHANGELOG.md b/CHANGELOG.md index f63a935417..df2a2723d2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,6 @@ # Changelog -## v.2.0.3 +## v.2.0.4 * Document and refactor internally. * Deprecate `text` prop in favor of `children` diff --git a/package.json b/package.json index 64d0d6059e..ae5544bc3a 100644 --- a/package.json +++ b/package.json @@ -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/.", diff --git a/src/InlineSpinner.md b/src/InlineSpinner.md new file mode 100644 index 0000000000..05eeb16305 --- /dev/null +++ b/src/InlineSpinner.md @@ -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 + Vennligst vent litt +``` diff --git a/src/LargeSpinner.md b/src/LargeSpinner.md new file mode 100644 index 0000000000..61ca6c8260 --- /dev/null +++ b/src/LargeSpinner.md @@ -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 +Vennligst vent litt +``` diff --git a/src/Spinner.js b/src/Spinner.js index 78c4ec725a..2496e73555 100644 --- a/src/Spinner.js +++ b/src/Spinner.js @@ -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 }) => (
diff --git a/src/Spinner.md b/src/Spinner.md new file mode 100644 index 0000000000..0692def1ab --- /dev/null +++ b/src/Spinner.md @@ -0,0 +1,25 @@ +# Spinner + +En selvstendig komponent for å vise at man venter på innholdet siden avhenger av. + +```js + +``` + +Den kan ha en tekst under seg som forklarer ventetiden: + +```js +Kalkulerer pris... +``` + +Den kan være venstrestilt: + +```js + +``` + +Den kan være stor: + +```js + +```