Skip to content

Commit 2afc4e6

Browse files
committed
docs: add <Dimmer> reference
1 parent 08ae414 commit 2afc4e6

File tree

6 files changed

+30
-2
lines changed

6 files changed

+30
-2
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@ const MyComponent = mock();
7777
- [`<Translations>`](./docs/en/translate.md#translations), [`<Translate>`](./docs/en/translate.md#translate-or-t), [`<T>`](./docs/en/translate.md#translate-or-t), [`withT()`](./docs/en/translate.md#witht-hoc), and [`@withT`](./docs/en/translate.md#witht-decorator)
7878
- [UI](./docs/en/UI.md)
7979
- [`<Portal>`](./docs/en/Portal.md), [`<Overlay>`](./docs/en/Overlay.md), and [`<Modal>`](./docs/en/Modal.md)
80+
- [`<Dimmer>`](./docs/en/Dimmer.md) and [`<Dimmable>`](./docs/en/Dimmable.md)
8081
- [`<FullScreen>`](./docs/en/FullScreen.md)
8182
- [`<Slider>`](./docs/en/Slider.md)
8283
- [`<DropArea>`](./docs/en/DropArea.md)

docs/en/Dimmer.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# `<Dimmer>`
2+
3+
Dims or create an overlay over its parent element.
4+
5+
6+
## Usage
7+
8+
```jsx
9+
import {Dimmer} from 'libreact/lib/Dimmer';
10+
11+
<div style={{width: 500, height: 300, border: '1px solid tomato'}}>
12+
Inline...
13+
<Dimmer>
14+
Children...
15+
</Dimmer>
16+
</div>
17+
```
18+
19+
20+
## Props
21+
22+
- `color` &mdash; optional, string, overlay color, defaults to `rgba(0,0,0,0.5)`.
23+
- `ms` &mdash; optional, number, background color appearance animation time in milliseconds, defaults to `300`.
24+
- `hidden` &mdash; optional, boolean, whther to hide dim overlay.

docs/en/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@
4646
- [`<Translations>`](./translate.md#translations), [`<Translate>`](./translate.md#translate-or-t), [`<T>`](./translate.md#translate-or-t), [`withT()`](./translate.md#witht-hoc), and [`@withT`](./translate.md#witht-decorator)
4747
- [UI](./UI.md)
4848
- [`<Portal>`](./Portal.md), [`<Overlay>`](./Overlay.md), and [`<Modal>`](./Modal.md)
49+
- [`<Dimmer>`](./Dimmer.md) and [`<Dimmable>`](./Dimmable.md)
4950
- [`<FullScreen>`](./FullScreen.md)
5051
- [`<Slider>`](./Slider.md)
5152
- [`<DropArea>`](./DropArea.md)

docs/en/SUMMARY.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,8 @@
5555
* [Portal](Portal.md)
5656
* [Overlay](Overlay.md)
5757
* [Modal](Modal.md)
58+
* [`<Dimmer>`](Dimmer.md)
59+
* [`<Dimmable>`](Dimmable.md)
5860
* [FullScreen](FullScreen.md)
5961
* [Slider](Slider.m
6062
* [`<DropArea>`](DropArea.md)

src/Dimmable/__story__/story.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import {Toggle} from '../../Toggle';
77
import ShowDocs from '../../../.storybook/ShowDocs'
88

99
storiesOf('UI/Dimmable', module)
10-
// .add('Documentation', () => h(ShowDocs, {md: require('../../../docs/en/Dimmable.md')}))
10+
.add('Documentation', () => h(ShowDocs, {md: require('../../../docs/en/Dimmable.md')}))
1111
.add('Text node', () =>
1212
<Toggle>{({on, toggle}) =>
1313
<div>

src/Dimmer/__story__/story.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import {Toggle} from '../../Toggle';
77
import ShowDocs from '../../../.storybook/ShowDocs'
88

99
storiesOf('UI/Dimmer', module)
10-
// .add('Documentation', () => h(ShowDocs, {md: require('../../../docs/en/Dimmer.md')}))
10+
.add('Documentation', () => h(ShowDocs, {md: require('../../../docs/en/Dimmer.md')}))
1111
.add('Example', () =>
1212
<div style={{width: 500, height: 300, border: '1px solid tomato', position: 'absolute'}}>
1313
Inline...

0 commit comments

Comments
 (0)