playbook_ui_docs 15.6.0 → 15.7.0.pre.rc.1

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.
Files changed (32) hide show
  1. checksums.yaml +4 -4
  2. data/app/pb_kits/playbook/pb_card/docs/_card_header.md +1 -1
  3. data/app/pb_kits/playbook/pb_card/docs/_card_highlight.md +1 -1
  4. data/app/pb_kits/playbook/pb_collapsible/docs/_collapsible_icons.jsx +0 -1
  5. data/app/pb_kits/playbook/pb_collapsible/docs/_collapsible_state.jsx +0 -3
  6. data/app/pb_kits/playbook/pb_distribution_bar/docs/_distribution_bar_custom_colors.md +1 -1
  7. data/app/pb_kits/playbook/pb_radio/docs/_radio_error.md +1 -1
  8. data/app/pb_kits/playbook/pb_select/docs/_select_error.md +1 -1
  9. data/app/pb_kits/playbook/pb_select/docs/_select_input_options.html.erb +16 -0
  10. data/app/pb_kits/playbook/pb_select/docs/_select_input_options.jsx +30 -0
  11. data/app/pb_kits/playbook/pb_select/docs/_select_input_options.md +1 -0
  12. data/app/pb_kits/playbook/pb_select/docs/example.yml +2 -0
  13. data/app/pb_kits/playbook/pb_select/docs/index.js +1 -0
  14. data/app/pb_kits/playbook/pb_table/docs/_table_with_filter_variant.jsx +134 -0
  15. data/app/pb_kits/playbook/pb_table/docs/_table_with_filter_variant.md +34 -0
  16. data/app/pb_kits/playbook/pb_table/docs/_table_with_filter_variant_rails.html.erb +101 -0
  17. data/app/pb_kits/playbook/pb_table/docs/_table_with_filter_variant_rails.md +33 -0
  18. data/app/pb_kits/playbook/pb_table/docs/_table_with_filter_variant_with_pagination.jsx +180 -0
  19. data/app/pb_kits/playbook/pb_table/docs/_table_with_filter_variant_with_pagination.md +3 -0
  20. data/app/pb_kits/playbook/pb_table/docs/_table_with_filter_variant_with_pagination_rails.html.erb +122 -0
  21. data/app/pb_kits/playbook/pb_table/docs/_table_with_filter_variant_with_pagination_rails.md +3 -0
  22. data/app/pb_kits/playbook/pb_table/docs/example.yml +4 -0
  23. data/app/pb_kits/playbook/pb_table/docs/index.js +2 -0
  24. data/app/pb_kits/playbook/pb_text_input/docs/_text_input_error.md +1 -1
  25. data/app/pb_kits/playbook/pb_textarea/docs/_textarea_error.md +1 -1
  26. data/app/pb_kits/playbook/pb_timeline/docs/_timeline_show_current_year.html.erb +60 -0
  27. data/app/pb_kits/playbook/pb_timeline/docs/_timeline_show_current_year.jsx +118 -0
  28. data/app/pb_kits/playbook/pb_timeline/docs/_timeline_show_current_year.md +1 -0
  29. data/app/pb_kits/playbook/pb_timeline/docs/_timeline_with_date.md +1 -1
  30. data/app/pb_kits/playbook/pb_timeline/docs/example.yml +2 -0
  31. data/app/pb_kits/playbook/pb_timeline/docs/index.js +1 -0
  32. metadata +16 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: d582a75099ed00437df8183003b0dccbb7d3b03bed14c60c9862b5719c1bd25b
4
- data.tar.gz: de86b06d011d974b9e08c986e3cbd453fdf6677c66c0c49b56983166c94b4d26
3
+ metadata.gz: 36ac9ddb221a32d5d396218a4ce18b98ceef1df64122da0078bc35a88064e3e2
4
+ data.tar.gz: ce783ac3ec36544323cffc819496775abf6ac9bca48d6b69d69c3ba78442982f
5
5
  SHA512:
6
- metadata.gz: 5d29763900c329aef04dd3cebf95dd7e688e18b177d24cd4f61487c06e4f1cc3a32f7391f07478111946e9eb3ccf0c760d6381b24d3d15b6ca1505101e3a4d95
7
- data.tar.gz: 34114d730d3612ae07f57bc5da535f9c689397b387cc4067ed04abc741658ce74e7c433ddceb051a94a96b2634614070a1905a66abae8c5008733a0207ad3ada
6
+ metadata.gz: e8c19d8f3a0e03a0bf0b55d5b0fc42f092c90654e74edec664ddaacf1424738d7548b938debdca61406e35031f10286dbaf94cd6c666e3be83606ca2bc2ba6cb
7
+ data.tar.gz: 86ae085b474dc80a95abf7f8fe4183d3304bbd07864694c7b891b63c2845aa643be026f8555c5feca17c0ef0217c6636949fcddbe8885d50645b25560bbeac3b
@@ -1 +1 @@
1
- Card headers pass category, product, status and background colors only. List of all category, product, status and background colors can be viewed <a href="https://playbook.powerapp.cloud/token/colors" target="_blank">here</a>.
1
+ Card headers pass category, product, status and background colors only. List of all category, product, status and background colors can be viewed <a href="https://playbook.powerapp.cloud/tokens/colors" target="_blank">here</a>.
@@ -1 +1 @@
1
- Card highlight can pass status, product, and category colors. List of all colors can be viewed <a href="https://playbook.powerapp.cloud/token/colors" target="_blank">here</a>.
1
+ Card highlight can pass status, product, and category colors. List of all colors can be viewed <a href="https://playbook.powerapp.cloud/tokens/colors" target="_blank">here</a>.
@@ -7,7 +7,6 @@ const CollapsibleIcons = (props) => {
7
7
  <>
8
8
  <Collapsible
9
9
  icon={['plus','minus']}
10
- iconColor='white'
11
10
  >
12
11
  <Collapsible.Main {...props}>
13
12
  <div>{'Main Section'}</div>
@@ -22,7 +22,6 @@ const CollapsibleState = (props) => {
22
22
  <Collapsible
23
23
  collapsed={isCollapsed}
24
24
  icon={["plus", "minus"]}
25
- iconColor='white'
26
25
  padding="none"
27
26
  >
28
27
  <Collapsible.Main padding="sm"
@@ -41,7 +40,6 @@ const CollapsibleState = (props) => {
41
40
  <Collapsible
42
41
  collapsed={isCollapsed}
43
42
  icon={["plus", "minus"]}
44
- iconColor='white'
45
43
  padding="none"
46
44
  >
47
45
  <Collapsible.Main padding="sm"
@@ -60,7 +58,6 @@ const CollapsibleState = (props) => {
60
58
  <Collapsible
61
59
  collapsed={isCollapsed}
62
60
  icon={["plus", "minus"]}
63
- iconColor='white'
64
61
  padding="none"
65
62
  >
66
63
  <Collapsible.Main padding="sm"
@@ -1 +1 @@
1
- You can customize the order of the colors you would like to use by using the `colors` prop. Only the data and status colors will work for Playbook charts. See the [design page](https://playbook.powerapp.cloud/token/colors) for reference.
1
+ You can customize the order of the colors you would like to use by using the `colors` prop. Only the data and status colors will work for Playbook charts. See the [design page](https://playbook.powerapp.cloud/tokens/colors) for reference.
@@ -1 +1 @@
1
- Error shows that the radio option must be selected or is invalid (ie when used in a form it signals a user to fix an error).
1
+ Error shows that the radio option must be selected or is invalid (i.e. when used in a form it signals a user to fix an error).
@@ -1 +1 @@
1
- Select w/ Error shows that the radio option must be selected or is invalid (ie when used in a form it signals a user to fix an error).
1
+ Select w/ Error shows that an option must be selected or is invalid (i.e. when used in a form it signals a user to fix an error).
@@ -0,0 +1,16 @@
1
+ <%= pb_rails("select", props: {
2
+ label: "Favorite Food",
3
+ name: "favorite_food",
4
+ options: [
5
+ { value: "pizza", value_text: "Pizza" },
6
+ { value: "tacos", value_text: "Tacos" },
7
+ { value: "sushi", value_text: "Sushi" }
8
+ ],
9
+ input_options: {
10
+ 'aria-label': "Select your favorite food",
11
+ class: "custom-select-class",
12
+ data: { controller: "search", action: "change->search#filter" },
13
+ id: "favorite-food-select"
14
+ }
15
+ }) %>
16
+
@@ -0,0 +1,30 @@
1
+ import React from 'react'
2
+
3
+ import Select from '../_select'
4
+
5
+ const SelectInputOptions = (props) => {
6
+ const options = [
7
+ { value: 'pizza', text: 'Pizza' },
8
+ { value: 'tacos', text: 'Tacos' },
9
+ { value: 'sushi', text: 'Sushi' },
10
+ ]
11
+
12
+ return (
13
+ <>
14
+ <Select
15
+ inputOptions={{
16
+ 'aria-label': 'Select your favorite food',
17
+ className: 'custom-select-class',
18
+ id: 'favorite-food-select',
19
+ }}
20
+ label="Favorite Food"
21
+ name="favorite_food"
22
+ options={options}
23
+ {...props}
24
+ />
25
+ </>
26
+ )
27
+ }
28
+
29
+ export default SelectInputOptions
30
+
@@ -0,0 +1 @@
1
+ Use the `input_options` / `inputOptions` prop to pass additional attributes directly to the underlying `<select>` element instead of the outer wrapper. This is useful for applying data attributes, custom IDs, or other HTML attributes that need to be on the select element itself.
@@ -15,6 +15,7 @@ examples:
15
15
  - select_inline_compact: Select Inline Compact
16
16
  - select_attributes: Select W/ Attributes
17
17
  - select_multiple: Select Multiple
18
+ - select_input_options: Input Options
18
19
 
19
20
 
20
21
 
@@ -33,6 +34,7 @@ examples:
33
34
  - select_inline_compact: Select Inline Compact
34
35
  - select_multiple: Select Multiple
35
36
  - select_react_hook: React Hook
37
+ - select_input_options: Input Options
36
38
 
37
39
  swift:
38
40
  - select_default_swift: Default
@@ -12,3 +12,4 @@ export { default as SelectInlineCompact } from './_select_inline_compact.jsx'
12
12
  export { default as SelectMultiple } from './_select_multiple.jsx'
13
13
  export { default as SelectReactHook } from './_select_react_hook.jsx'
14
14
  export { default as SelectCustomSelectSubheaders } from './_select_custom_select_subheaders.jsx'
15
+ export { default as SelectInputOptions } from './_select_input_options.jsx'
@@ -0,0 +1,134 @@
1
+ import React, { useState } from "react"
2
+ import { Button, Date as DateKit, DatePicker, Dropdown, Select, Table, TextInput, Typeahead, Flex } from "playbook-ui"
3
+
4
+ // Mock Data for Table
5
+ const users = [
6
+ { id: 1, name: "Jennifer", title: "Associate Scrum Master", department: "Business Technology", branch: "Philadelphia", startDate: "2025-01-01" },
7
+ { id: 2, name: "Nick", title: "UX Engineer II", department: "Business Technology", branch: "Philadelphia", startDate: "2025-01-02" },
8
+ { id: 3, name: "Nida", title: "Senior UX Engineer", department: "Business Technology", branch: "Philadelphia", startDate: "2025-01-03" },
9
+ { id: 4, name: "Justin", title: "Director of User Experience Engineering", department: "Business Technology", branch: "Philadelphia", startDate: "2025-01-04" },
10
+ { id: 5, name: "Edward", title: "UX Designer II", department: "Business Technology", branch: "Philadelphia", startDate: "2025-01-05" },
11
+ { id: 6, name: "Elisa", title: "UX Engineer", department: "Business Technology", branch: "Philadelphia", startDate: "2025-01-06" },
12
+ { id: 7, name: "Gary", title: "UX Engineer", department: "Business Technology", branch: "Philadelphia", startDate: "2025-01-07" },
13
+ { id: 8, name: "Barkley", title: "Nitro Quality Ninja", department: "Business Technology", branch: "Philadelphia", startDate: "2025-01-08" },
14
+ { id: 9, name: "Aaron", title: "Associate Nitro Quality Ninja", department: "Business Technology", branch: "Philadelphia", startDate: "2025-01-09" },
15
+ ]
16
+
17
+ const TableWithFilterVariant = () => {
18
+ const [territory, setTerritory] = useState("")
19
+
20
+ // --------Filter content example ------
21
+ const filterContent = ({ closePopover }) => (
22
+ <>
23
+ <TextInput
24
+ label="Territory ID"
25
+ onChange={event => setTerritory(event.target.value)}
26
+ value={territory}
27
+ />
28
+
29
+ <Typeahead
30
+ label="Title"
31
+ options={[
32
+ { key: "senior-ux-engineer", label: "Senior UX Engineer", value: "senior-ux-engineer" },
33
+ { key: "ux-engineer", label: "UX Engineer", value: "ux-engineer" },
34
+ { key: "ux-designer", label: "UX Designer", value: "ux-designer" }
35
+ ]}
36
+ />
37
+
38
+ <Select
39
+ blankSelection="All Departments"
40
+ label="Department"
41
+ options={[
42
+ { value: "Business Technology", label: "Business Technology", key: "business-technology" },
43
+ { value: "Customer Development", label: "Customer Development", key: "customer-development" },
44
+ { value: "Talent Acquisition", label: "Talent Acquisition", key: "talent-acquisition" }
45
+ ]}
46
+ />
47
+
48
+ <Dropdown
49
+ label="Branch"
50
+ options={[
51
+ { key: "Philadelphia", label: "Philadelphia", value: "philadelphia" },
52
+ { key: "New York", label: "New York", value: "new-york" },
53
+ { key: "Austin", label: "Austin", value: "austin" }
54
+ ]}
55
+ />
56
+
57
+ <DatePicker
58
+ label="Start Date"
59
+ paddingY="sm"
60
+ pickerId="startedOn"
61
+ />
62
+ <Flex spacing="between">
63
+ <Button
64
+ onClick={() => {
65
+ alert("No filtering functionality - just a pattern demo!")
66
+ closePopover()
67
+ }}
68
+ text="Filter"
69
+ />
70
+ <Button
71
+ text="Defaults"
72
+ variant="secondary"
73
+ />
74
+ </Flex>
75
+ </>
76
+ )
77
+ // -------End Filter content example ------
78
+
79
+ return (
80
+ <Table
81
+ filterContent={filterContent}
82
+ filterProps={{
83
+ results: 50,
84
+ sortOptions: {
85
+ territory_id: "Territory ID",
86
+ first_name: "Name",
87
+ started_on: "Start Date",
88
+ department_name: "Department",
89
+ title_name: "Title",
90
+ branch_branch_name: "Branch",
91
+ },
92
+ sortValue: [{ name: 'started_on', dir: 'asc' }],
93
+ }}
94
+ title="Table Title Here"
95
+ variant="withFilter"
96
+ >
97
+ <Table.Head>
98
+ <Table.Row>
99
+ <Table.Header>{'Territory ID'}</Table.Header>
100
+ <Table.Header>{'Name'}</Table.Header>
101
+ <Table.Header>{'Title'}</Table.Header>
102
+ <Table.Header>{'Department'}</Table.Header>
103
+ <Table.Header>{'Branch'}</Table.Header>
104
+ <Table.Header textAlign="right">{'Start Date'}</Table.Header>
105
+ </Table.Row>
106
+ </Table.Head>
107
+ <Table.Body>
108
+ {users.map((user) => (
109
+ <Table.Row key={user.id}>
110
+ <Table.Cell
111
+ marginX={{ xs: "sm" }}
112
+ numberSpacing="tabular"
113
+ >
114
+ {user.id}
115
+ </Table.Cell>
116
+ <Table.Cell marginX={{ xs: "sm" }}>{user.name}</Table.Cell>
117
+ <Table.Cell marginX={{ xs: "sm" }}>{user.title}</Table.Cell>
118
+ <Table.Cell marginX={{ xs: "sm" }}>{user.department}</Table.Cell>
119
+ <Table.Cell marginX={{ xs: "sm" }}>{user.branch}</Table.Cell>
120
+ <Table.Cell marginX={{ xs: "sm" }}>
121
+ <DateKit
122
+ alignment="right"
123
+ showCurrentYear
124
+ value={user.startDate}
125
+ />
126
+ </Table.Cell>
127
+ </Table.Row>
128
+ ))}
129
+ </Table.Body>
130
+ </Table>
131
+ )
132
+ }
133
+
134
+ export default TableWithFilterVariant
@@ -0,0 +1,34 @@
1
+ Set the `variant` prop to `withFilter` to render a Table with a filter. The variant automatically handles:
2
+
3
+ - Card wrapper with standard responsive margins
4
+ - Optional `title` prop to render title above the card
5
+ - Filter component rendering with Design defaults
6
+ - SectionSeparator between filter and table
7
+ - Flex layout for proper alignment
8
+
9
+ #### Required Props
10
+
11
+ - `variant="withFilter"`: Enables the filter variant
12
+ - `filterContent`: A function that receives `{ closePopover }` and returns the filter's body content (inputs, buttons, etc.). Use this to pass in all input kits, etc needed inside the Filter itself.
13
+ - `filterProps`: An object containing Filter-specific props like `results`, `sortOptions`, `sortValue`, etc.
14
+
15
+ #### Optional Props
16
+
17
+ - `title`: Displays a title above the card
18
+ - All standard Table props (`size`, `collapse`, etc.) can be used, but defaults are already set to match Design guidelines
19
+ - All standard Filter props can be used, but defaults are already set to match Design guidelines.
20
+
21
+ #### Default Filter Props
22
+
23
+ The Table kit automatically sets these Filter defaults (which you can override via `filterProps`):
24
+
25
+ - `background={false}`
26
+ - `maxHeight="50vh"`
27
+ - `minWidth="xs"`
28
+ - `popoverProps={{ width: "350px" }}`
29
+
30
+
31
+ **IMPORTANT NOTE**:
32
+ The purpose of this variant is to provide an easy way to set up a Table with a Filter with Design standards applied by default.
33
+
34
+ If you are looking for more customization than this embedded variant provides, you may be better served by using the individual kits as demonstrated in our Table Filter Card Building Block [here](https://playbook.powerapp.cloud/building_blocks/table_filter_card/react).
@@ -0,0 +1,101 @@
1
+ <% users = [
2
+ { id: 1, name: "Jennifer", title: "Associate Scrum Master", department: "Business Technology", branch: "Philadelphia", start_date: Date.new(2025, 1, 1) },
3
+ { id: 2, name: "Nick", title: "UX Engineer II", department: "Business Technology", branch: "Philadelphia", start_date: Date.new(2025, 1, 2) },
4
+ { id: 3, name: "Nida", title: "Senior UX Engineer", department: "Business Technology", branch: "Philadelphia", start_date: Date.new(2025, 1, 3) },
5
+ { id: 4, name: "Justin", title: "Director of User Experience Engineering", department: "Business Technology", branch: "Philadelphia", start_date: Date.new(2025, 1, 4) },
6
+ { id: 5, name: "Edward", title: "UX Designer II", department: "Business Technology", branch: "Philadelphia", start_date: Date.new(2025, 1, 5) },
7
+ { id: 6, name: "Elisa", title: "UX Engineer", department: "Business Technology", branch: "Philadelphia", start_date: Date.new(2025, 1, 6) },
8
+ { id: 7, name: "Gary", title: "UX Engineer", department: "Business Technology", branch: "Philadelphia", start_date: Date.new(2025, 1, 7) },
9
+ { id: 8, name: "Barkley", title: "Nitro Quality Ninja", department: "Business Technology", branch: "Philadelphia", start_date: Date.new(2025, 1, 8) },
10
+ { id: 9, name: "Aaron", title: "Associate Nitro Quality Ninja", department: "Business Technology", branch: "Philadelphia", start_date: Date.new(2025, 1, 9) },
11
+ ] %>
12
+
13
+ <% filter_content =
14
+ pb_rails("text_input", props: {
15
+ label: "Territory ID",
16
+ placeholder: "Enter Territory ID"
17
+ }) +
18
+ pb_rails("typeahead", props: {
19
+ label: "Title",
20
+ options: [
21
+ { label: "Senior UX Engineer", value: "senior-ux-engineer" },
22
+ { label: "UX Engineer", value: "ux-engineer" },
23
+ { label: "UX Designer", value: "ux-designer" }
24
+ ]
25
+ }) +
26
+ pb_rails("select", props: {
27
+ blank_selection: "All Departments",
28
+ label: "Department",
29
+ options: [
30
+ { value: "Business Technology", text: "Business Technology" },
31
+ { value: "Customer Development", text: "Customer Development" },
32
+ { value: "Talent Acquisition", text: "Talent Acquisition" }
33
+ ]
34
+ }) +
35
+ pb_rails("dropdown", props: {
36
+ label: "Branch",
37
+ options: [
38
+ { label: "Philadelphia", value: "philadelphia" },
39
+ { label: "New York", value: "new-york" },
40
+ { label: "Austin", value: "austin" }
41
+ ]
42
+ }) +
43
+ pb_rails("date_picker", props: {
44
+ label: "Start Date",
45
+ padding_y: "sm",
46
+ picker_id: "startedOn"
47
+ }) +
48
+ pb_rails("flex", props: { spacing: "between" }) do
49
+ pb_rails("button", props: {
50
+ text: "Filter",
51
+ }) +
52
+ pb_rails("button", props: {
53
+ text: "Defaults",
54
+ variant: "secondary"
55
+ })
56
+ end
57
+ %>
58
+
59
+ <%= pb_rails("table", props: {
60
+ variant: "with_filter",
61
+ title: "Table Title Here",
62
+ filter_content: filter_content,
63
+ filter_props: {
64
+ id: "user-table-filters-1",
65
+ results: 9,
66
+ sort_menu: [
67
+ { item: "Start Date", link: "?q[sorts]=started_on+asc", active: true, direction: "asc" },
68
+ { item: "First Name", link: "?q[sorts]=name+asc", active: false },
69
+ { item: "Title", link: "?q[sorts]=title+asc", active: false },
70
+ { item: "Department", link: "?q[sorts]=department+asc", active: false },
71
+ { item: "Branch", link: "?q[sorts]=branch+asc", active: false },
72
+ { item: "Territory ID", link: "?q[sorts]=territory_id+asc", active: false },
73
+ ],
74
+ }
75
+ }) do %>
76
+ <%= pb_rails("table/table_head") do %>
77
+ <%= pb_rails("table/table_row") do %>
78
+ <%= pb_rails("table/table_header", props: { text: "Territory ID" }) %>
79
+ <%= pb_rails("table/table_header", props: { text: "Name" }) %>
80
+ <%= pb_rails("table/table_header", props: { text: "Title" }) %>
81
+ <%= pb_rails("table/table_header", props: { text: "Department" }) %>
82
+ <%= pb_rails("table/table_header", props: { text: "Branch" }) %>
83
+ <%= pb_rails("table/table_header", props: { text: "Start Date", text_align: "right" }) %>
84
+ <% end %>
85
+ <% end %>
86
+
87
+ <%= pb_rails("table/table_body") do %>
88
+ <% users.each do |user| %>
89
+ <%= pb_rails("table/table_row") do %>
90
+ <%= pb_rails("table/table_cell", props: { margin_x: { xs: "sm" }, number_spacing: "tabular" }) { user[:id].to_s } %>
91
+ <%= pb_rails("table/table_cell", props: { margin_x: { xs: "sm" } }) { user[:name] } %>
92
+ <%= pb_rails("table/table_cell", props: { margin_x: { xs: "sm" } }) { user[:title] } %>
93
+ <%= pb_rails("table/table_cell", props: { margin_x: { xs: "sm" } }) { user[:department] } %>
94
+ <%= pb_rails("table/table_cell", props: { margin_x: { xs: "sm" } }) { user[:branch] } %>
95
+ <%= pb_rails("table/table_cell", props: { margin_x: { xs: "sm" } }) do %>
96
+ <%= pb_rails("date", props: {alignment: "right", date: user[:start_date].to_s, show_current_year: true } ) %>
97
+ <% end %>
98
+ <% end %>
99
+ <% end %>
100
+ <% end %>
101
+ <% end %>
@@ -0,0 +1,33 @@
1
+ Set the `variant` prop to `with_filter` to render a Table with a filter. The variant automatically handles:
2
+
3
+ - Card wrapper with standard responsive margins
4
+ - Optional `title` prop to render title above the card
5
+ - Filter component rendering with Design defaults
6
+ - SectionSeparator between filter and table
7
+ - Flex layout for proper alignment
8
+
9
+ #### Required Props
10
+
11
+ - `variant: "with_filter"`: Enables the filter variant
12
+ - `filter_content`: The filter's body content (inputs, buttons, etc.) built with `pb_rails` string concatenation
13
+ - `filter_props`: A hash containing Filter-specific props like `results`, `sort_menu`, etc.
14
+
15
+ #### Optional Props
16
+
17
+ - `title`: Displays a title above the card
18
+ - All standard Table props (`size`, `collapse`, etc.) can be used, but defaults are already set to match Design guidelines
19
+
20
+ #### Default Filter Props
21
+
22
+ The Table kit automatically sets these Filter defaults (which you can override via `filter_props`):
23
+
24
+ - `background: false`
25
+ - `max_height: "50vh"`
26
+ - `min_width: "xs"`
27
+ - `popover_props: { width: "350px" }`
28
+
29
+
30
+ **IMPORTANT NOTE**:
31
+ The purpose of this variant is to provide an easy way to set up a Table with a Filter with Design standards applied by default.
32
+
33
+ If you are looking for more customization than this embedded variant provides, you may be better served by using the individual kits as demonstrating in our Table Filter Card Building Block as seen [here](https://playbook.powerapp.cloud/building_blocks/table_filter_card/rails).
@@ -0,0 +1,180 @@
1
+ import React, { useState } from "react"
2
+ import { Button, Date as DateKit, DatePicker, Dropdown, Pagination, Select, Table, TextInput, Typeahead, Flex } from "playbook-ui"
3
+
4
+
5
+ // Mock Data for Table
6
+ const users = [
7
+ { id: 1, name: "Jennifer", title: "Associate Scrum Master", department: "Business Technology", branch: "Philadelphia", startDate: "2025-01-01" },
8
+ { id: 2, name: "Nick", title: "UX Engineer II", department: "Business Technology", branch: "Philadelphia", startDate: "2025-01-02" },
9
+ { id: 3, name: "Nida", title: "Senior UX Engineer", department: "Business Technology", branch: "Philadelphia", startDate: "2025-01-03" },
10
+ { id: 4, name: "Justin", title: "Director of User Experience Engineering", department: "Business Technology", branch: "Philadelphia", startDate: "2025-01-04" },
11
+ { id: 5, name: "Edward", title: "UX Designer II", department: "Business Technology", branch: "Philadelphia", startDate: "2025-01-05" },
12
+ { id: 6, name: "Elisa", title: "UX Engineer", department: "Business Technology", branch: "Philadelphia", startDate: "2025-01-06" },
13
+ { id: 7, name: "Gary", title: "UX Engineer", department: "Business Technology", branch: "Philadelphia", startDate: "2025-01-07" },
14
+ { id: 8, name: "Barkley", title: "Nitro Quality Ninja", department: "Business Technology", branch: "Philadelphia", startDate: "2025-01-08" },
15
+ { id: 9, name: "Aaron", title: "Associate Nitro Quality Ninja", department: "Business Technology", branch: "Philadelphia", startDate: "2025-01-09" },
16
+ { id: 10, name: "Sarah", title: "Senior Product Manager", department: "Business Technology", branch: "New York", startDate: "2025-01-10" },
17
+ { id: 11, name: "Michael", title: "Software Engineer III", department: "Business Technology", branch: "Austin", startDate: "2025-01-11" },
18
+ { id: 12, name: "Emma", title: "Data Analyst II", department: "Customer Development", branch: "Philadelphia", startDate: "2025-01-12" },
19
+ { id: 13, name: "David", title: "QA Engineer", department: "Business Technology", branch: "New York", startDate: "2025-01-13" },
20
+ { id: 14, name: "Lisa", title: "UX Researcher", department: "Business Technology", branch: "Philadelphia", startDate: "2025-01-14" },
21
+ { id: 15, name: "James", title: "DevOps Engineer", department: "Business Technology", branch: "Austin", startDate: "2025-01-15" },
22
+ { id: 16, name: "Anna", title: "Product Designer", department: "Business Technology", branch: "Philadelphia", startDate: "2025-01-16" },
23
+ { id: 17, name: "Robert", title: "Backend Engineer", department: "Business Technology", branch: "New York", startDate: "2025-01-17" },
24
+ { id: 18, name: "Maria", title: "Frontend Developer", department: "Business Technology", branch: "Austin", startDate: "2025-01-18" },
25
+ { id: 19, name: "William", title: "Tech Lead", department: "Business Technology", branch: "Philadelphia", startDate: "2025-01-19" },
26
+ { id: 20, name: "Jessica", title: "Scrum Master", department: "Business Technology", branch: "New York", startDate: "2025-01-20" },
27
+ { id: 21, name: "Daniel", title: "Software Architect", department: "Business Technology", branch: "Austin", startDate: "2025-01-21" },
28
+ { id: 22, name: "Laura", title: "Business Analyst", department: "Customer Development", branch: "Philadelphia", startDate: "2025-01-22" },
29
+ { id: 23, name: "Chris", title: "Security Engineer", department: "Business Technology", branch: "New York", startDate: "2025-01-23" },
30
+ { id: 24, name: "Ashley", title: "UX Engineer III", department: "Business Technology", branch: "Austin", startDate: "2025-01-24" },
31
+ { id: 25, name: "Kevin", title: "Platform Engineer", department: "Business Technology", branch: "Philadelphia", startDate: "2025-01-25" },
32
+ { id: 26, name: "Michelle", title: "Content Designer", department: "Business Technology", branch: "New York", startDate: "2025-01-26" },
33
+ ]
34
+
35
+
36
+ const TableWithFilterVariantWithPagination = () => {
37
+ const [territory, setTerritory] = useState("")
38
+ // ------Pagination-----
39
+ const [activePage, setActivePage] = useState(1)
40
+ // Calculate pagination
41
+ const itemsPerPage = 20
42
+ const totalPages = Math.ceil(users.length / itemsPerPage)
43
+ const startIndex = (activePage - 1) * itemsPerPage
44
+ const endIndex = startIndex + itemsPerPage
45
+ const currentData = users.slice(startIndex, endIndex)
46
+
47
+ const onPageChange = (page) => {
48
+ setActivePage(page)
49
+ }
50
+ // ------End Pagination-----
51
+
52
+ // -------Filter content example ------
53
+ const filterContent = ({ closePopover }) => (
54
+ <>
55
+ <TextInput
56
+ label="Territory ID"
57
+ onChange={event => setTerritory(event.target.value)}
58
+ value={territory}
59
+ />
60
+ <Typeahead
61
+ label="Title"
62
+ options={[
63
+ { key: "senior-ux-engineer", label: "Senior UX Engineer", value: "senior-ux-engineer" },
64
+ { key: "ux-engineer", label: "UX Engineer", value: "ux-engineer" },
65
+ { key: "ux-designer", label: "UX Designer", value: "ux-designer" }
66
+ ]}
67
+ />
68
+
69
+ <Select
70
+ blankSelection="All Departments"
71
+ label="Department"
72
+ options={[
73
+ { value: "Business Technology", label: "Business Technology", key: "business-technology" },
74
+ { value: "Customer Development", label: "Customer Development", key: "customer-development" },
75
+ { value: "Talent Acquisition", label: "Talent Acquisition", key: "talent-acquisition" }
76
+ ]}
77
+ />
78
+
79
+ <Dropdown
80
+ label="Branch"
81
+ options={[
82
+ { key: "Philadelphia", label: "Philadelphia", value: "philadelphia" },
83
+ { key: "New York", label: "New York", value: "new-york" },
84
+ { key: "Austin", label: "Austin", value: "austin" }
85
+ ]}
86
+ />
87
+
88
+ <DatePicker
89
+ label="Start Date"
90
+ paddingY="sm"
91
+ pickerId="startedOn"
92
+ />
93
+ <Flex spacing="between">
94
+ <Button
95
+ onClick={() => {
96
+ alert("No filtering functionality - just a pattern demo!")
97
+ closePopover()
98
+ }}
99
+ text="Filter"
100
+ />
101
+ <Button
102
+ text="Defaults"
103
+ variant="secondary"
104
+ />
105
+ </Flex>
106
+ </>
107
+ )
108
+ // -------End Filter content example ------
109
+
110
+ // -------Pagination element example ------
111
+ const paginationElement = (
112
+ <Pagination
113
+ current={activePage}
114
+ key={`pagination-${activePage}`}
115
+ marginLeft="lg"
116
+ onChange={onPageChange}
117
+ paddingY="xs"
118
+ range={5}
119
+ total={totalPages}
120
+ />
121
+ )
122
+ // -------End Pagination element example ------
123
+
124
+ return (
125
+ <Table
126
+ filterContent={filterContent}
127
+ filterProps={{
128
+ results: 50,
129
+ sortOptions: {
130
+ territory_id: "Territory ID",
131
+ first_name: "Name",
132
+ started_on: "Start Date",
133
+ department_name: "Department",
134
+ title_name: "Title",
135
+ branch_branch_name: "Branch",
136
+ },
137
+ sortValue: [{ name: 'started_on', dir: 'asc' }],
138
+ }}
139
+ pagination={paginationElement}
140
+ title="Table Title Here"
141
+ variant="withFilter"
142
+ >
143
+ <Table.Head>
144
+ <Table.Row>
145
+ <Table.Header>{'Territory ID'}</Table.Header>
146
+ <Table.Header>{'Name'}</Table.Header>
147
+ <Table.Header>{'Title'}</Table.Header>
148
+ <Table.Header>{'Department'}</Table.Header>
149
+ <Table.Header>{'Branch'}</Table.Header>
150
+ <Table.Header textAlign="right">{'Start Date'}</Table.Header>
151
+ </Table.Row>
152
+ </Table.Head>
153
+ <Table.Body>
154
+ {currentData.map((user) => (
155
+ <Table.Row key={user.id}>
156
+ <Table.Cell
157
+ marginX={{ xs: "sm" }}
158
+ numberSpacing="tabular"
159
+ >
160
+ {user.id}
161
+ </Table.Cell>
162
+ <Table.Cell marginX={{ xs: "sm" }}>{user.name}</Table.Cell>
163
+ <Table.Cell marginX={{ xs: "sm" }}>{user.title}</Table.Cell>
164
+ <Table.Cell marginX={{ xs: "sm" }}>{user.department}</Table.Cell>
165
+ <Table.Cell marginX={{ xs: "sm" }}>{user.branch}</Table.Cell>
166
+ <Table.Cell marginX={{ xs: "sm" }}>
167
+ <DateKit
168
+ alignment="right"
169
+ showCurrentYear
170
+ value={user.startDate}
171
+ />
172
+ </Table.Cell>
173
+ </Table.Row>
174
+ ))}
175
+ </Table.Body>
176
+ </Table>
177
+ )
178
+ }
179
+
180
+ export default TableWithFilterVariantWithPagination
@@ -0,0 +1,3 @@
1
+ The `withFilter` variant can also be used with the Pagination kit as shown here. Simply set up your Pagination as normal, and pass the Pagination kit to the prop `pagination` as shown.
2
+
3
+ For more information on the Pagination Kit and how to use it, see the documentation [here](https://playbook.powerapp.cloud/kits/pagination/react)
@@ -0,0 +1,122 @@
1
+ <% users = [
2
+ { id: 1, name: "Jennifer", title: "Associate Scrum Master", department: "Business Technology", branch: "Philadelphia", start_date: Date.new(2025, 1, 1) },
3
+ { id: 2, name: "Nick", title: "UX Engineer II", department: "Business Technology", branch: "Philadelphia", start_date: Date.new(2025, 1, 2) },
4
+ { id: 3, name: "Nida", title: "Senior UX Engineer", department: "Business Technology", branch: "Philadelphia", start_date: Date.new(2025, 1, 3) },
5
+ { id: 4, name: "Justin", title: "Director of User Experience Engineering", department: "Business Technology", branch: "Philadelphia", start_date: Date.new(2025, 1, 4) },
6
+ { id: 5, name: "Edward", title: "UX Designer II", department: "Business Technology", branch: "Philadelphia", start_date: Date.new(2025, 1, 5) },
7
+ { id: 6, name: "Elisa", title: "UX Engineer", department: "Business Technology", branch: "Philadelphia", start_date: Date.new(2025, 1, 6) },
8
+ { id: 7, name: "Gary", title: "UX Engineer", department: "Business Technology", branch: "Philadelphia", start_date: Date.new(2025, 1, 7) },
9
+ { id: 8, name: "Barkley", title: "Nitro Quality Ninja", department: "Business Technology", branch: "Philadelphia", start_date: Date.new(2025, 1, 8) },
10
+ { id: 9, name: "Aaron", title: "Associate Nitro Quality Ninja", department: "Business Technology", branch: "Philadelphia", start_date: Date.new(2025, 1, 9) },
11
+ { id: 10, name: "Sarah", title: "Senior Product Manager", department: "Business Technology", branch: "New York", start_date: Date.new(2025, 1, 10) },
12
+ { id: 11, name: "Michael", title: "Software Engineer III", department: "Business Technology", branch: "Austin", start_date: Date.new(2025, 1, 11) },
13
+ { id: 12, name: "Emma", title: "Data Analyst II", department: "Customer Development", branch: "Philadelphia", start_date: Date.new(2025, 1, 12) },
14
+ { id: 13, name: "David", title: "QA Engineer", department: "Business Technology", branch: "New York", start_date: Date.new(2025, 1, 13) },
15
+ { id: 14, name: "Lisa", title: "UX Researcher", department: "Business Technology", branch: "Philadelphia", start_date: Date.new(2025, 1, 14) },
16
+ { id: 15, name: "James", title: "DevOps Engineer", department: "Business Technology", branch: "Austin", start_date: Date.new(2025, 1, 15) },
17
+ { id: 16, name: "Anna", title: "Product Designer", department: "Business Technology", branch: "Philadelphia", start_date: Date.new(2025, 1, 16) },
18
+ { id: 17, name: "Robert", title: "Backend Engineer", department: "Business Technology", branch: "New York", start_date: Date.new(2025, 1, 17) },
19
+ { id: 18, name: "Maria", title: "Frontend Developer", department: "Business Technology", branch: "Austin", start_date: Date.new(2025, 1, 18) },
20
+ { id: 19, name: "William", title: "Tech Lead", department: "Business Technology", branch: "Philadelphia", start_date: Date.new(2025, 1, 19) },
21
+ { id: 20, name: "Jessica", title: "Scrum Master", department: "Business Technology", branch: "New York", start_date: Date.new(2025, 1, 20) },
22
+ { id: 21, name: "Daniel", title: "Software Architect", department: "Business Technology", branch: "Austin", start_date: Date.new(2025, 1, 21) },
23
+ { id: 22, name: "Laura", title: "Business Analyst", department: "Customer Development", branch: "Philadelphia", start_date: Date.new(2025, 1, 22) },
24
+ { id: 23, name: "Chris", title: "Security Engineer", department: "Business Technology", branch: "New York", start_date: Date.new(2025, 1, 23) },
25
+ { id: 24, name: "Ashley", title: "UX Engineer III", department: "Business Technology", branch: "Austin", start_date: Date.new(2025, 1, 24) },
26
+ { id: 25, name: "Kevin", title: "Platform Engineer", department: "Business Technology", branch: "Philadelphia", start_date: Date.new(2025, 1, 25) },
27
+ { id: 26, name: "Michelle", title: "Content Designer", department: "Business Technology", branch: "New York", start_date: Date.new(2025, 1, 26) },
28
+ ] %>
29
+
30
+ <% filter_content =
31
+ pb_rails("text_input", props: {
32
+ label: "Territory ID",
33
+ placeholder: "Enter Territory ID"
34
+ }) +
35
+ pb_rails("typeahead", props: {
36
+ label: "Title",
37
+ options: [
38
+ { label: "Senior UX Engineer", value: "senior-ux-engineer" },
39
+ { label: "UX Engineer", value: "ux-engineer" },
40
+ { label: "UX Designer", value: "ux-designer" }
41
+ ]
42
+ }) +
43
+ pb_rails("select", props: {
44
+ blank_selection: "All Departments",
45
+ label: "Department",
46
+ options: [
47
+ { value: "Business Technology", text: "Business Technology" },
48
+ { value: "Customer Development", text: "Customer Development" },
49
+ { value: "Talent Acquisition", text: "Talent Acquisition" }
50
+ ]
51
+ }) +
52
+ pb_rails("dropdown", props: {
53
+ label: "Branch",
54
+ options: [
55
+ { label: "Philadelphia", value: "philadelphia" },
56
+ { label: "New York", value: "new-york" },
57
+ { label: "Austin", value: "austin" }
58
+ ]
59
+ }) +
60
+ pb_rails("date_picker", props: {
61
+ label: "Start Date",
62
+ padding_y: "sm",
63
+ picker_id: "startedOn"
64
+ }) +
65
+ pb_rails("flex", props: { spacing: "between" }) do
66
+ pb_rails("button", props: {
67
+ text: "Filter",
68
+ }) +
69
+ pb_rails("button", props: {
70
+ text: "Defaults",
71
+ variant: "secondary"
72
+ })
73
+ end
74
+ %>
75
+
76
+ <%# Replace "model" in pagination here with your specific data source %>
77
+ <% pagination_element = pb_rails("pagination", props: { model: @users, view: self, padding_y:"xs", margin_left:"lg" }) %>
78
+
79
+ <%= pb_rails("table", props: {
80
+ variant: "with_filter",
81
+ title: "Table Title Here",
82
+ filter_content: filter_content,
83
+ pagination: pagination_element,
84
+ filter_props: {
85
+ id: "user-table-filters-2",
86
+ results: users.length,
87
+ sort_menu: [
88
+ { item: "Start Date", link: "?q[sorts]=started_on+asc", active: true, direction: "asc" },
89
+ { item: "First Name", link: "?q[sorts]=name+asc", active: false },
90
+ { item: "Title", link: "?q[sorts]=title+asc", active: false },
91
+ { item: "Department", link: "?q[sorts]=department+asc", active: false },
92
+ { item: "Branch", link: "?q[sorts]=branch+asc", active: false },
93
+ { item: "Territory ID", link: "?q[sorts]=territory_id+asc", active: false },
94
+ ],
95
+ }
96
+ }) do %>
97
+ <%= pb_rails("table/table_head") do %>
98
+ <%= pb_rails("table/table_row") do %>
99
+ <%= pb_rails("table/table_header", props: { text: "Territory ID" }) %>
100
+ <%= pb_rails("table/table_header", props: { text: "Name" }) %>
101
+ <%= pb_rails("table/table_header", props: { text: "Title" }) %>
102
+ <%= pb_rails("table/table_header", props: { text: "Department" }) %>
103
+ <%= pb_rails("table/table_header", props: { text: "Branch" }) %>
104
+ <%= pb_rails("table/table_header", props: { text: "Start Date", text_align: "right" }) %>
105
+ <% end %>
106
+ <% end %>
107
+
108
+ <%= pb_rails("table/table_body") do %>
109
+ <% users.each do |user| %>
110
+ <%= pb_rails("table/table_row") do %>
111
+ <%= pb_rails("table/table_cell", props: { margin_x: { xs: "sm" }, number_spacing: "tabular" }) { user[:id].to_s } %>
112
+ <%= pb_rails("table/table_cell", props: { margin_x: { xs: "sm" } }) { user[:name] } %>
113
+ <%= pb_rails("table/table_cell", props: { margin_x: { xs: "sm" } }) { user[:title] } %>
114
+ <%= pb_rails("table/table_cell", props: { margin_x: { xs: "sm" } }) { user[:department] } %>
115
+ <%= pb_rails("table/table_cell", props: { margin_x: { xs: "sm" } }) { user[:branch] } %>
116
+ <%= pb_rails("table/table_cell", props: { margin_x: { xs: "sm" } }) do %>
117
+ <%= pb_rails("date", props: {alignment: "right", date: user[:start_date].to_s, show_current_year: true } ) %>
118
+ <% end %>
119
+ <% end %>
120
+ <% end %>
121
+ <% end %>
122
+ <% end %>
@@ -0,0 +1,3 @@
1
+ The `with_filter` variant can also be used with the Pagination kit as shown here. Simply set up your Pagination as normal, and pass the Pagination kit to the prop `pagination` as shown.
2
+
3
+ **IMPORTANT NOTE**: This is NOT a working example of pagination, please set up your use case with the relevant data in your controller. For more information on the Pagination Kit and how to use it, see the documentation [here](https://playbook.powerapp.cloud/kits/pagination/rails)
@@ -40,6 +40,8 @@ examples:
40
40
  - table_with_selectable_rows: Table with Selectable Rows
41
41
  - table_with_header_style_borderless: Header Style Borderless
42
42
  - table_with_header_style_floating: Header Style Floating
43
+ - table_with_filter_variant_rails: Variant with Filter
44
+ - table_with_filter_variant_with_pagination_rails: Variant with Filter and Pagination
43
45
 
44
46
  react:
45
47
  - table_sm: Small
@@ -81,3 +83,5 @@ examples:
81
83
  - table_with_selectable_rows: Table with Selectable Rows
82
84
  - table_with_header_style_borderless: Header Style Borderless
83
85
  - table_with_header_style_floating: Header Style Floating
86
+ - table_with_filter_variant: Variant with Filter
87
+ - table_with_filter_variant_with_pagination: Variant with Filter and Pagination
@@ -38,3 +38,5 @@ export { default as TableWithSelectableRows } from './_table_with_selectable_row
38
38
  export { default as TableWithClickableRows } from './_table_with_clickable_rows.jsx'
39
39
  export { default as TableWithHeaderStyleBorderless } from './_table_with_header_style_borderless.jsx'
40
40
  export { default as TableWithHeaderStyleFloating } from './_table_with_header_style_floating.jsx'
41
+ export { default as TableWithFilterVariant } from './_table_with_filter_variant.jsx'
42
+ export { default as TableWithFilterVariantWithPagination } from './_table_with_filter_variant_with_pagination.jsx'
@@ -1 +1 @@
1
- Text Input w/ Error shows that the radio option must be selected or is invalid (ie when used in a form it signals a user to fix an error).
1
+ Text Input w/ Error shows that the input must be filled out (i.e. when used in a form it signals a user to fix an error).
@@ -1 +1 @@
1
- Textarea w/ Error shows that the radio option must be selected or is invalid (ie when used in a form it signals a user to fix an error).
1
+ Textarea w/ Error shows that the input must be filled out (i.e. when used in a form it signals a user to fix an error).
@@ -0,0 +1,60 @@
1
+ <%= pb_rails("timeline", props: {orientation: "horizontal", show_date: true}) do %>
2
+ <%= pb_rails("timeline/item", props: {icon: "user", icon_color: "royal", line_style: "solid", date: Date.today, show_current_year: true }) do %>
3
+ <%= pb_rails("title_detail", props: {
4
+ title: "Jackson Heights",
5
+ detail: "37-27 74th Street"
6
+ }) %>
7
+ <% end %>
8
+ <%= pb_rails("timeline/item", props: {icon: "check", icon_color: "teal", line_style: "dotted" }) do %>
9
+ <%= pb_rails("title_detail", props: {
10
+ title: "Greenpoint",
11
+ detail: "81 Gate St Brooklyn"
12
+ }) %>
13
+ <% end %>
14
+ <%= pb_rails("timeline/item", props: { line_style: "solid"}) do |item| %>
15
+ <% item.label do %>
16
+ <%= pb_rails("timeline/label", props: { date: Date.today, show_current_year: true }) %>
17
+ <% end %>
18
+ <% item.step do %>
19
+ <%= pb_rails("timeline/step", props: { icon: 'map-marker-alt', icon_color: 'purple' }) %>
20
+ <% end %>
21
+ <% item.detail do %>
22
+ <%= pb_rails("title_detail", props: {
23
+ title: "Society Hill",
24
+ detail: "72 E St Astoria"
25
+ }) %>
26
+ <% end %>
27
+ <% end %>
28
+ <% end %>
29
+
30
+ <br /><br /><br />
31
+
32
+ <%= pb_rails("timeline", props: {orientation: "vertical", show_date: true}) do %>
33
+ <%= pb_rails("timeline/item", props: {icon: "user", icon_color: "royal", line_style: "solid", date: Date.today, show_current_year: true }) do %>
34
+ <%= pb_rails("title_detail", props: {
35
+ title: "Jackson Heights",
36
+ detail: "37-27 74th Street"
37
+ }) %>
38
+ <% end %>
39
+ <%= pb_rails("timeline/item", props: {icon: "check", icon_color: "teal", line_style: "dotted" }) do %>
40
+ <%= pb_rails("title_detail", props: {
41
+ title: "Greenpoint",
42
+ detail: "81 Gate St Brooklyn"
43
+ }) %>
44
+ <% end %>
45
+ <%= pb_rails("timeline/item", props: { line_style: "solid"}) do |item| %>
46
+ <% item.label do %>
47
+ <%= pb_rails("timeline/label", props: { date: Date.today, show_current_year: true }) %>
48
+ <% end %>
49
+ <% item.step do %>
50
+ <%= pb_rails("timeline/step", props: { icon: 'map-marker-alt', icon_color: 'purple' }) %>
51
+ <% end %>
52
+ <% item.detail do %>
53
+ <%= pb_rails("title_detail", props: {
54
+ title: "Society Hill",
55
+ detail: "72 E St Astoria"
56
+ }) %>
57
+ <% end %>
58
+ <% end %>
59
+ <% end %>
60
+
@@ -0,0 +1,118 @@
1
+ import React from 'react'
2
+
3
+ import Timeline from '../_timeline'
4
+ import TitleDetail from '../../pb_title_detail/_title_detail'
5
+
6
+ const TimelineShowCurrentYear = (props) => (
7
+ <div>
8
+ <Timeline
9
+ orientation="horizontal"
10
+ showDate
11
+ {...props}
12
+ >
13
+ <Timeline.Item
14
+ date={new Date()}
15
+ icon="user"
16
+ iconColor="royal"
17
+ showCurrentYear
18
+ {...props}
19
+ >
20
+ <TitleDetail
21
+ detail="37-27 74th Street"
22
+ title="Jackson Heights"
23
+ {...props}
24
+ />
25
+ </Timeline.Item>
26
+ <Timeline.Item
27
+ icon="check"
28
+ iconColor="teal"
29
+ lineStyle="dotted"
30
+ {...props}
31
+ >
32
+ <TitleDetail
33
+ detail="81 Gate St Brooklyn"
34
+ title="Greenpoint"
35
+ {...props}
36
+ />
37
+ </Timeline.Item>
38
+ <Timeline.Item
39
+ lineStyle="solid"
40
+ {...props}
41
+ >
42
+ <Timeline.Label
43
+ date={new Date()}
44
+ showCurrentYear
45
+ />
46
+ <Timeline.Step
47
+ icon="map-marker-alt"
48
+ iconColor="purple"
49
+ />
50
+ <Timeline.Detail>
51
+ <TitleDetail
52
+ detail="72 E St Astoria"
53
+ title="Society Hill"
54
+ {...props}
55
+ />
56
+ </Timeline.Detail>
57
+ </Timeline.Item>
58
+ </Timeline>
59
+
60
+ <br />
61
+ <br />
62
+ <br />
63
+
64
+ <Timeline
65
+ orientation="vertical"
66
+ showDate
67
+ {...props}
68
+ >
69
+ <Timeline.Item
70
+ date={new Date()}
71
+ icon="user"
72
+ iconColor="royal"
73
+ showCurrentYear
74
+ {...props}
75
+ >
76
+ <TitleDetail
77
+ detail="37-27 74th Street"
78
+ title="Jackson Heights"
79
+ {...props}
80
+ />
81
+ </Timeline.Item>
82
+ <Timeline.Item
83
+ icon="check"
84
+ iconColor="teal"
85
+ lineStyle="dotted"
86
+ {...props}
87
+ >
88
+ <TitleDetail
89
+ detail="81 Gate St Brooklyn"
90
+ title="Greenpoint"
91
+ {...props}
92
+ />
93
+ </Timeline.Item>
94
+ <Timeline.Item
95
+ lineStyle="solid"
96
+ {...props}
97
+ >
98
+ <Timeline.Label
99
+ date={new Date()}
100
+ showCurrentYear
101
+ />
102
+ <Timeline.Step
103
+ icon="map-marker-alt"
104
+ iconColor="purple"
105
+ />
106
+ <Timeline.Detail>
107
+ <TitleDetail
108
+ detail="72 E St Astoria"
109
+ title="Society Hill"
110
+ {...props}
111
+ />
112
+ </Timeline.Detail>
113
+ </Timeline.Item>
114
+ </Timeline>
115
+ </div>
116
+ )
117
+
118
+ export default TimelineShowCurrentYear
@@ -0,0 +1 @@
1
+ By default, the Timeline kit does NOT display the year if it is the current year. If you want to display the current year you can do so by setting `showCurrentYear`/`show_current_year` to true. Pass it to `Timeline.Item`/`timeline/item` when using its `date` prop, or to `Timeline.Label`/`timeline/label` if following the "With Children" pattern.
@@ -1 +1 @@
1
- Use the optional `showDate` prop to render the timeline kit with a visible date. If the date is from the current year, the year will not be displayed, however if date is NOT from the current year, the kit will display the year as well.
1
+ Use the optional `showDate` prop to render the timeline kit with a visible date. By default, if the date is from the current year, the year will not be displayed; however, if the date is NOT from the current year, the kit will display the year as well.
@@ -5,6 +5,7 @@ examples:
5
5
  - timeline_vertical: Vertical
6
6
  - timeline_with_date: With Date
7
7
  - timeline_with_children: With Children
8
+ - timeline_show_current_year: Show Current Year
8
9
  - timeline_with_gap: With Gap
9
10
 
10
11
 
@@ -13,4 +14,5 @@ examples:
13
14
  - timeline_vertical: Vertical
14
15
  - timeline_with_date: With Date
15
16
  - timeline_with_children: With Children
17
+ - timeline_show_current_year: Show Current Year
16
18
  - timeline_with_gap: With Gap
@@ -3,4 +3,5 @@ export { default as TimelineVertical } from './_timeline_vertical.jsx'
3
3
  export { default as TimelineWithDate } from './_timeline_with_date.jsx'
4
4
  export { default as TimelineWithChildren } from './_timeline_with_children.jsx'
5
5
  export { default as TimelineWithGap } from './_timeline_with_gap.jsx'
6
+ export { default as TimelineShowCurrentYear } from './_timeline_show_current_year.jsx'
6
7
 
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: 15.6.0
4
+ version: 15.7.0.pre.rc.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Power UX
@@ -9,7 +9,7 @@ authors:
9
9
  autorequire:
10
10
  bindir: bin
11
11
  cert_chain: []
12
- date: 2025-12-05 00:00:00.000000000 Z
12
+ date: 2025-12-11 00:00:00.000000000 Z
13
13
  dependencies:
14
14
  - !ruby/object:Gem::Dependency
15
15
  name: playbook_ui
@@ -2061,6 +2061,9 @@ files:
2061
2061
  - app/pb_kits/playbook/pb_select/docs/_select_inline_compact.jsx
2062
2062
  - app/pb_kits/playbook/pb_select/docs/_select_inline_show_arrow.html.erb
2063
2063
  - app/pb_kits/playbook/pb_select/docs/_select_inline_show_arrow.jsx
2064
+ - app/pb_kits/playbook/pb_select/docs/_select_input_options.html.erb
2065
+ - app/pb_kits/playbook/pb_select/docs/_select_input_options.jsx
2066
+ - app/pb_kits/playbook/pb_select/docs/_select_input_options.md
2064
2067
  - app/pb_kits/playbook/pb_select/docs/_select_multiple.html.erb
2065
2068
  - app/pb_kits/playbook/pb_select/docs/_select_multiple.jsx
2066
2069
  - app/pb_kits/playbook/pb_select/docs/_select_multiple.md
@@ -2304,6 +2307,14 @@ files:
2304
2307
  - app/pb_kits/playbook/pb_table/docs/_table_with_dynamic_collapsible.jsx
2305
2308
  - app/pb_kits/playbook/pb_table/docs/_table_with_dynamic_collapsible_rails.md
2306
2309
  - app/pb_kits/playbook/pb_table/docs/_table_with_dynamic_collapsible_react.md
2310
+ - app/pb_kits/playbook/pb_table/docs/_table_with_filter_variant.jsx
2311
+ - app/pb_kits/playbook/pb_table/docs/_table_with_filter_variant.md
2312
+ - app/pb_kits/playbook/pb_table/docs/_table_with_filter_variant_rails.html.erb
2313
+ - app/pb_kits/playbook/pb_table/docs/_table_with_filter_variant_rails.md
2314
+ - app/pb_kits/playbook/pb_table/docs/_table_with_filter_variant_with_pagination.jsx
2315
+ - app/pb_kits/playbook/pb_table/docs/_table_with_filter_variant_with_pagination.md
2316
+ - app/pb_kits/playbook/pb_table/docs/_table_with_filter_variant_with_pagination_rails.html.erb
2317
+ - app/pb_kits/playbook/pb_table/docs/_table_with_filter_variant_with_pagination_rails.md
2307
2318
  - app/pb_kits/playbook/pb_table/docs/_table_with_header_style_borderless.html.erb
2308
2319
  - app/pb_kits/playbook/pb_table/docs/_table_with_header_style_borderless.jsx
2309
2320
  - app/pb_kits/playbook/pb_table/docs/_table_with_header_style_borderless_rails.md
@@ -2408,6 +2419,9 @@ files:
2408
2419
  - app/pb_kits/playbook/pb_timeline/docs/_description.md
2409
2420
  - app/pb_kits/playbook/pb_timeline/docs/_timeline_default.html.erb
2410
2421
  - app/pb_kits/playbook/pb_timeline/docs/_timeline_default.jsx
2422
+ - app/pb_kits/playbook/pb_timeline/docs/_timeline_show_current_year.html.erb
2423
+ - app/pb_kits/playbook/pb_timeline/docs/_timeline_show_current_year.jsx
2424
+ - app/pb_kits/playbook/pb_timeline/docs/_timeline_show_current_year.md
2411
2425
  - app/pb_kits/playbook/pb_timeline/docs/_timeline_vertical.html.erb
2412
2426
  - app/pb_kits/playbook/pb_timeline/docs/_timeline_vertical.jsx
2413
2427
  - app/pb_kits/playbook/pb_timeline/docs/_timeline_with_children.html.erb