playbook_ui_docs 14.17.0.pre.alpha.play1906overlaykitaddopacityandgradient7232 → 14.17.0.pre.alpha.playcdntest7233
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/app/pb_kits/playbook/pb_overlay/docs/_overlay_default.md +7 -1
- data/app/pb_kits/playbook/pb_overlay/docs/example.yml +0 -3
- data/app/pb_kits/playbook/pb_overlay/docs/index.js +0 -3
- data/dist/playbook-doc.js +1 -1
- metadata +1 -7
- data/app/pb_kits/playbook/pb_overlay/docs/_overlay_color.jsx +0 -63
- data/app/pb_kits/playbook/pb_overlay/docs/_overlay_color.md +0 -3
- data/app/pb_kits/playbook/pb_overlay/docs/_overlay_gradient_opacity.jsx +0 -39
- data/app/pb_kits/playbook/pb_overlay/docs/_overlay_gradient_opacity.md +0 -1
- data/app/pb_kits/playbook/pb_overlay/docs/_overlay_layout.jsx +0 -40
- data/app/pb_kits/playbook/pb_overlay/docs/_overlay_layout.md +0 -5
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: playbook_ui_docs
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 14.17.0.pre.alpha.
|
|
4
|
+
version: 14.17.0.pre.alpha.playcdntest7233
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Power UX
|
|
@@ -1433,19 +1433,13 @@ files:
|
|
|
1433
1433
|
- app/pb_kits/playbook/pb_online_status/docs/_online_status_size.jsx
|
|
1434
1434
|
- app/pb_kits/playbook/pb_online_status/docs/example.yml
|
|
1435
1435
|
- app/pb_kits/playbook/pb_online_status/docs/index.js
|
|
1436
|
-
- app/pb_kits/playbook/pb_overlay/docs/_overlay_color.jsx
|
|
1437
|
-
- app/pb_kits/playbook/pb_overlay/docs/_overlay_color.md
|
|
1438
1436
|
- app/pb_kits/playbook/pb_overlay/docs/_overlay_default.html.erb
|
|
1439
1437
|
- app/pb_kits/playbook/pb_overlay/docs/_overlay_default.jsx
|
|
1440
1438
|
- app/pb_kits/playbook/pb_overlay/docs/_overlay_default.md
|
|
1441
|
-
- app/pb_kits/playbook/pb_overlay/docs/_overlay_gradient_opacity.jsx
|
|
1442
|
-
- app/pb_kits/playbook/pb_overlay/docs/_overlay_gradient_opacity.md
|
|
1443
1439
|
- app/pb_kits/playbook/pb_overlay/docs/_overlay_hide_scroll_bar.html.erb
|
|
1444
1440
|
- app/pb_kits/playbook/pb_overlay/docs/_overlay_hide_scroll_bar.jsx
|
|
1445
1441
|
- app/pb_kits/playbook/pb_overlay/docs/_overlay_hide_scroll_bar_rails.md
|
|
1446
1442
|
- app/pb_kits/playbook/pb_overlay/docs/_overlay_hide_scroll_bar_react.md
|
|
1447
|
-
- app/pb_kits/playbook/pb_overlay/docs/_overlay_layout.jsx
|
|
1448
|
-
- app/pb_kits/playbook/pb_overlay/docs/_overlay_layout.md
|
|
1449
1443
|
- app/pb_kits/playbook/pb_overlay/docs/_overlay_multi_directional.html.erb
|
|
1450
1444
|
- app/pb_kits/playbook/pb_overlay/docs/_overlay_multi_directional.jsx
|
|
1451
1445
|
- app/pb_kits/playbook/pb_overlay/docs/_overlay_multi_directional.md
|
|
@@ -1,63 +0,0 @@
|
|
|
1
|
-
import React from 'react'
|
|
2
|
-
|
|
3
|
-
import Overlay from '../../pb_overlay/_overlay'
|
|
4
|
-
import Image from '../../pb_image/_image'
|
|
5
|
-
import Flex from '../../pb_flex/_flex'
|
|
6
|
-
|
|
7
|
-
const OverlayColor = () => (
|
|
8
|
-
<Flex
|
|
9
|
-
justify="around"
|
|
10
|
-
wrap
|
|
11
|
-
>
|
|
12
|
-
<Overlay
|
|
13
|
-
color="black"
|
|
14
|
-
marginBottom="xxs"
|
|
15
|
-
>
|
|
16
|
-
<Image
|
|
17
|
-
alt="picture of a misty forest"
|
|
18
|
-
display="block"
|
|
19
|
-
size="xl"
|
|
20
|
-
url="https://unsplash.it/500/400/?image=634"
|
|
21
|
-
/>
|
|
22
|
-
</Overlay>
|
|
23
|
-
<Overlay
|
|
24
|
-
color="black"
|
|
25
|
-
gradient={false}
|
|
26
|
-
marginBottom="xxs"
|
|
27
|
-
opacity="opacity_4"
|
|
28
|
-
>
|
|
29
|
-
<Image
|
|
30
|
-
alt="picture of a misty forest"
|
|
31
|
-
display="block"
|
|
32
|
-
size="xl"
|
|
33
|
-
url="https://unsplash.it/500/400/?image=634"
|
|
34
|
-
/>
|
|
35
|
-
</Overlay>
|
|
36
|
-
<Overlay
|
|
37
|
-
color="error"
|
|
38
|
-
marginBottom="xxs"
|
|
39
|
-
>
|
|
40
|
-
<Image
|
|
41
|
-
alt="picture of a misty forest"
|
|
42
|
-
display="block"
|
|
43
|
-
size="xl"
|
|
44
|
-
url="https://unsplash.it/500/400/?image=634"
|
|
45
|
-
/>
|
|
46
|
-
</Overlay>
|
|
47
|
-
<Overlay
|
|
48
|
-
color="error"
|
|
49
|
-
gradient={false}
|
|
50
|
-
marginBottom="xxs"
|
|
51
|
-
opacity="opacity_4"
|
|
52
|
-
>
|
|
53
|
-
<Image
|
|
54
|
-
alt="picture of a misty forest"
|
|
55
|
-
display="block"
|
|
56
|
-
size="xl"
|
|
57
|
-
url="https://unsplash.it/500/400/?image=634"
|
|
58
|
-
/>
|
|
59
|
-
</Overlay>
|
|
60
|
-
</Flex>
|
|
61
|
-
)
|
|
62
|
-
|
|
63
|
-
export default OverlayColor
|
|
@@ -1,3 +0,0 @@
|
|
|
1
|
-
The `color` prop is used to change the color of the solid or gradient mask. Gradient overlays always start opaque and fade to transparent.
|
|
2
|
-
|
|
3
|
-
NOTE: Images are set to `display: block` to remove the default inline spacing caused by line height. This ensures the image fully fills the container without unexpected gaps.
|
|
@@ -1,39 +0,0 @@
|
|
|
1
|
-
import React from 'react'
|
|
2
|
-
|
|
3
|
-
import Overlay from '../../pb_overlay/_overlay'
|
|
4
|
-
import Image from '../../pb_image/_image'
|
|
5
|
-
import Flex from '../../pb_flex/_flex'
|
|
6
|
-
|
|
7
|
-
const OverlayGradientOpacity = () => (
|
|
8
|
-
<Flex
|
|
9
|
-
justify="around"
|
|
10
|
-
wrap
|
|
11
|
-
>
|
|
12
|
-
<Overlay
|
|
13
|
-
gradient={false}
|
|
14
|
-
marginBottom="xxs"
|
|
15
|
-
opacity="opacity_2"
|
|
16
|
-
>
|
|
17
|
-
<Image
|
|
18
|
-
alt="picture of a misty forest"
|
|
19
|
-
display="block"
|
|
20
|
-
maxWidth="100%"
|
|
21
|
-
url="https://unsplash.it/500/400/?image=634"
|
|
22
|
-
/>
|
|
23
|
-
</Overlay>
|
|
24
|
-
<Overlay
|
|
25
|
-
gradient={false}
|
|
26
|
-
marginBottom="xxs"
|
|
27
|
-
opacity="opacity_8"
|
|
28
|
-
>
|
|
29
|
-
<Image
|
|
30
|
-
alt="picture of a misty forest"
|
|
31
|
-
display="block"
|
|
32
|
-
maxWidth="100%"
|
|
33
|
-
url="https://unsplash.it/500/400/?image=634"
|
|
34
|
-
/>
|
|
35
|
-
</Overlay>
|
|
36
|
-
</Flex>
|
|
37
|
-
)
|
|
38
|
-
|
|
39
|
-
export default OverlayGradientOpacity
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
By default, the overlay is rendered as a gradient. Setting the `gradient` prop to `false` renders the overlay as a solid color. You can adjust the transparency of the solid overlay by using the `opacity` prop.
|
|
@@ -1,40 +0,0 @@
|
|
|
1
|
-
import React from 'react'
|
|
2
|
-
|
|
3
|
-
import Overlay from '../../pb_overlay/_overlay'
|
|
4
|
-
import Table from '../../pb_table/_table'
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
const TableExample = () => {
|
|
8
|
-
return (
|
|
9
|
-
<Table size="sm">
|
|
10
|
-
<thead>
|
|
11
|
-
<tr>
|
|
12
|
-
<th>{'Column 1'}</th>
|
|
13
|
-
<th>{'Column 2'}</th>
|
|
14
|
-
<th>{'Column 3'}</th>
|
|
15
|
-
<th>{'Column 4'}</th>
|
|
16
|
-
<th>{'Column 5'}</th>
|
|
17
|
-
</tr>
|
|
18
|
-
</thead>
|
|
19
|
-
<tbody>
|
|
20
|
-
{Array.from({ length: 7 }, (_, index) => (
|
|
21
|
-
<tr key={index}>
|
|
22
|
-
{Array.from({ length: 5 }, (_, columnIndex) => (
|
|
23
|
-
<td key={columnIndex}>{`Value ${columnIndex + 1}`}</td>
|
|
24
|
-
))}
|
|
25
|
-
</tr>
|
|
26
|
-
))}
|
|
27
|
-
</tbody>
|
|
28
|
-
</Table>
|
|
29
|
-
)
|
|
30
|
-
}
|
|
31
|
-
|
|
32
|
-
const OverlayLayout = () => (
|
|
33
|
-
<>
|
|
34
|
-
<Overlay layout={{ y: "xl" }}>
|
|
35
|
-
<TableExample />
|
|
36
|
-
</Overlay>
|
|
37
|
-
</>
|
|
38
|
-
)
|
|
39
|
-
|
|
40
|
-
export default OverlayLayout
|
|
@@ -1,5 +0,0 @@
|
|
|
1
|
-
The optional `layout` prop accepts the `position` and `size` of the overlay as a key:value pair.
|
|
2
|
-
|
|
3
|
-
The `position` key accepts `bottom` (default), `top`, `y` (for both top and bottom) `right`, `left`, or `x` (for both left and right), which sets the side(s) where the `color` overlay starts. The direction of the overlay is always toward the opposite side of the position. For example, the default position of `bottom` starts the overlay on the bottom edge of your container and extends it toward the opposite side: the top.
|
|
4
|
-
|
|
5
|
-
The `size` value is `full` (100%) by default, but accepts our [spacing tokens](https://playbook.powerapp.cloud/visual_guidelines/spacing) or a percentage value as a string, and literally translates to how much of the container is covered by the overlay(s).
|