Skip to content

Commit 11a2d19

Browse files
authored
Merge branch 'master' into add-metasection-props-to-readme
2 parents dc619c7 + 99cfe5b commit 11a2d19

File tree

3 files changed

+49
-3
lines changed

3 files changed

+49
-3
lines changed

lib/InfoPopover/readme.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,5 +25,7 @@ contentClass | string | `className` for content inside popover |
2525
iconSize | string | The size of the icon (`small` or `medium`) | small
2626
hideOnButtonClick | boolean | Whether to hide popover on anchor button click | false
2727
renderTrigger | func | Render a custom trigger button. The function will receive an object that contains the the `open`-state, a `ref` that needs to be passed onto trigger button and a `toggle`-function for toggling the `<InfoPopover>`. The render function should return a button. |
28+
buttonProps | object | Pass additional props to the trigger `<IconButton>` | `{}`
29+
popperProps | object | Pass additional props to the underlying `<Popper>` | `{}`
2830

2931
The remaining props passed to `<InfoPopover>` will be passed down to the internal `<Popover>`.

lib/Loading/readme.md

Lines changed: 36 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,39 @@
22

33
Components for loading animations for various scenarios within your application.
44

5-
- `<Loading>` a basic, standalone loading spinner
6-
- `<LoadingPane>` a Pane with a loading spinner. For use within existing `<Paneset>`s. Accepts the props of `<Pane>`.
7-
- `<LoadingView>` for fullscreen views. Accepts the props of `<Pane>` and includes a wrapping `<Paneset>`.
5+
## `<Loading>`: a basic, standalone loading spinner
6+
7+
| Property | Type | Description | Default | Required |
8+
| --- | --- | --- | --- | --- |
9+
| size | `small`, `medium`, `large`, or `xlarge` | The size of the loading icon | `medium` | |
10+
| useCurrentColor | boolean | If the current element's CSS text `color` should be used instead of the default grey | `false` | |
11+
12+
### Example
13+
14+
```jsx
15+
<Loading />
16+
```
17+
18+
## `<LoadingPane>`: a Pane with a loading spinner
19+
20+
For use within existing `<Paneset>`s. Accepts the props of `<Pane>`.
21+
22+
Accepts all properties of [<Pane>](https://github.com/folio-org/stripes-components/blob/master/lib/Pane/readme.md#props), however,
23+
`defaultWidth` is optional (set to `fill` by default). Any provided `children` will be ignored.
24+
25+
### Example
26+
27+
```jsx
28+
<LoadingPane defaultWidth="20%" paneTitle="Filters" />
29+
```
30+
31+
## `<LoadingView>`: for fullscreen views
32+
33+
Accepts the same props as `<LoadingPane>`, with the addition of `panesetProps`. `panesetProps` will be passed to the underlying
34+
`<Paneset>` and all other props will be passed to the underlying `<Pane>`.
35+
36+
### Example
37+
38+
```jsx
39+
<LoadingView paneTitle="Content" panesetProps={{isRoot: true}} />
40+
```

lib/Spinner/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Spinner
2+
3+
Renders a loading spinner icon.
4+
5+
## Props
6+
None
7+
8+
## Usage
9+
```jsx
10+
<Spinner />
11+
```

0 commit comments

Comments
 (0)