playbook_ui_docs 16.4.0.pre.alpha.PLAY2718containerfalseborderradiusresponsiveonly15164 → 16.4.0.pre.alpha.PLAY2846reactadvancedtablecalcheaderpinnedrows15356

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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 955221598614b89a5ea56915a4147b016ee929378a372502fb05ba1f677dbd45
4
- data.tar.gz: 5f0ecab16e7a07dfb66e3ec91397e33c0348123911a658506c8b318e2d0579fe
3
+ metadata.gz: 3026c5233df2384f10b391571f568a131a007e0e78d21616e95a5ac4f1945eb7
4
+ data.tar.gz: 0a50a88af3c3b9c87dfcf50727bc1c18cb5009cbf1b3a704cd1be59a75d6aa7c
5
5
  SHA512:
6
- metadata.gz: 864cb97ebc2cb3ca94fd2460eb755f929993e773e7867d7a7a78e8d943ba2798c80a0d3ba933583fde99c705d6bc467fcc7872774bbda20aa32a9c5b52928b70
7
- data.tar.gz: 99782531502ddde43861858ece6e9a911936d4554b6e40aae0357fe502ff900ec8de962e03c7a35a722dec5ababec18de3e6b6183a81a6d82b0ffefc489785b2
6
+ metadata.gz: eb6c8ae67d6b638e8d168fde7972e719df60ea5bdfb6059119a70c49bb8aafd7fa1fc94e060d04bae8abf5194a853b4cdf030af1bf5dd244d595a327258434d2
7
+ data.tar.gz: b895c084767ae70729d4168d6fe2bebd9ec69738399272b3f31052f13e706c9beb31d85869c2803755febbed66bd411d29d18118c7e1c7256e8538e105e78c0f
@@ -30,34 +30,4 @@
30
30
  }
31
31
  ] %>
32
32
 
33
- <%= pb_rails("caption", props: { text: "Default Advanced Table Table Props Doc Example" }) %>
34
- <%= pb_rails("advanced_table", props: { id: "table_props_table", table_data: @table_data, column_definitions: column_definitions, table_props: { vertical_border: true, container: false }}) %>
35
-
36
- <%= pb_rails("caption", props: { text: "Advanced Table with just container: false" }) %>
37
- <%= pb_rails("advanced_table", props: { id: "table_props_table_2", table_data: @table_data, column_definitions: column_definitions, table_props: { container: false }}) %>
38
-
39
- <%= pb_rails("caption", props: { text: "Typical set up: Card and Flex around Filter, SectionSeparator, and AdvancedTable with container: false" }) %>
40
- <%= pb_rails("card", props: { padding: "none", margin_bottom: "xl" }) do %>
41
- <%= pb_rails("flex", props: { align: "stretch", orientation: "column", gap: "none" }) do %>
42
- <%= pb_rails("filter", props: {
43
- background: false,
44
- max_height: (@table_data.to_a.size < 10) ? "50vh" : "none",
45
- min_width: "xs",
46
- popover_props: { width: "350px" },
47
- id: "rails-table-props-filter-with-data",
48
- template: "single",
49
- results: @table_data.to_a.size,
50
- }) do %>
51
- <%= pb_form_with(scope: :example, method: :get, url: "", validate: true) do |form| %>
52
- <%= form.number_field :new_leads_eq, props: { label: "New Leads" } %>
53
- <%= form.text_field :conversion_rate_eq, props: { label: "Conversion Rate" } %>
54
- <%= form.actions do |action| %>
55
- <%= action.submit props: { text: "Filter" } %>
56
- <%= action.button props: { type: "reset", text: "Defaults", variant: "secondary" } %>
57
- <% end %>
58
- <% end %>
59
- <% end %>
60
- <%= pb_rails("section_separator") %>
61
- <%= pb_rails("advanced_table", props: { id: "rails_template_advanced_table", table_data: @table_data, column_definitions: column_definitions, table_props: { container: false } }) %>
62
- <% end %>
63
- <% end %>
33
+ <%= pb_rails("advanced_table", props: { id: "table_props_table", table_data: @table_data, column_definitions: column_definitions, table_props: { vertical_border: true, container: false }}) %>
@@ -1,13 +1,6 @@
1
1
  import React from "react"
2
2
  import AdvancedTable from '../../pb_advanced_table/_advanced_table'
3
3
  import MOCK_DATA from "./advanced_table_mock_data.json"
4
- import Button from "../../pb_button/_button"
5
- import Caption from "../../pb_caption/_caption"
6
- import Card from "../../pb_card/_card"
7
- import Filter from "../../pb_filter/_filter"
8
- import Flex from "../../pb_flex/_flex"
9
- import SectionSeparator from "../../pb_section_separator/_section_separator"
10
- import TextInput from "../../pb_text_input/_text_input"
11
4
 
12
5
  const AdvancedTableTableProps = (props) => {
13
6
  const columnDefinitions = [
@@ -47,100 +40,14 @@ const AdvancedTableTableProps = (props) => {
47
40
  verticalBorder: true
48
41
  }
49
42
 
50
- const filterPopoverProps = { width: "350px" }
51
-
52
- const filterForm = (closePopover) => (
53
- <form>
54
- <TextInput
55
- label="New Leads"
56
- name="new_leads_eq"
57
- placeholder="0"
58
- type="number"
59
- {...props}
60
- />
61
- <TextInput
62
- label="Conversion Rate"
63
- name="conversion_rate_eq"
64
- placeholder="e.g. 12%"
65
- {...props}
66
- />
67
- <Flex
68
- spacing="between"
69
- {...props}
70
- >
71
- <Button
72
- onClick={closePopover}
73
- text="Filter"
74
- {...props}
75
- />
76
- <Button
77
- text="Defaults"
78
- type="reset"
79
- variant="secondary"
80
- {...props}
81
- />
82
- </Flex>
83
- </form>
84
- )
85
-
86
43
  return (
87
44
  <div>
88
- <Caption
89
- text="Default Advanced Table Table Props Doc Example"
90
- />
91
45
  <AdvancedTable
92
46
  columnDefinitions={columnDefinitions}
93
- marginBottom="md"
94
47
  tableData={MOCK_DATA}
95
48
  tableProps={tableProps}
96
49
  {...props}
97
50
  />
98
- <Caption
99
- text="Advanced Table with just container: false"
100
- />
101
- <AdvancedTable
102
- columnDefinitions={columnDefinitions}
103
- marginBottom="md"
104
- tableData={MOCK_DATA}
105
- tableProps={{container: false}}
106
- {...props}
107
- />
108
-
109
- <Caption
110
- text="Typical set up: Card and Flex around Filter, SectionSeparator, and AdvancedTable with container: false"
111
- />
112
- <Card
113
- marginBottom="xl"
114
- padding="none"
115
- {...props}
116
- >
117
- <Flex
118
- align="stretch"
119
- gap="none"
120
- orientation="column"
121
- {...props}
122
- >
123
- <Filter
124
- background={false}
125
- id="react-table-props-filter-with-data"
126
- maxHeight={MOCK_DATA.length < 10 ? "50vh" : "none"}
127
- minWidth="xs"
128
- popoverProps={filterPopoverProps}
129
- results={MOCK_DATA.length}
130
- {...props}
131
- >
132
- {({ closePopover }) => filterForm(closePopover)}
133
- </Filter>
134
- <SectionSeparator {...props} />
135
- <AdvancedTable
136
- columnDefinitions={columnDefinitions}
137
- id="react_template_advanced_table"
138
- tableData={MOCK_DATA}
139
- tableProps={{container: false}}
140
- {...props}
141
- />
142
- </Flex>
143
- </Card>
144
51
  </div>
145
52
  )
146
53
  }
@@ -0,0 +1,19 @@
1
+ This button is used many times for mobile or other things like cards and sidebars.
2
+
3
+ ### Responsive `display` and `full_width`
4
+
5
+ `full_width` applies block styling that includes `display: flex` on the **same element** as the button. The **`display` global prop** also sets `display` (via utility classes, often with `!important`).
6
+
7
+ Putting **both** on one button means **two systems control `display` on one node**, which can cause wrong visibility (e.g. both a header and a full-width mobile button showing) or confusing cascade behavior.
8
+
9
+ **Recommended:** Put responsive `display` on a **parent** (e.g. `Flex`, `Card`, or a plain wrapper) and keep `full_width` only on the `Button` inside. The wrapper handles show/hide by breakpoint; the button only handles full-width layout.
10
+
11
+ ```erb
12
+ <%= pb_rails("flex", props: {
13
+ display: { xs: "flex", default: "none" },
14
+ orientation: "column",
15
+ width: "100%",
16
+ }) do %>
17
+ <%= pb_rails("button", props: { full_width: true, text: "Add" }) %>
18
+ <% end %>
19
+ ```
@@ -0,0 +1,23 @@
1
+ This button is used many times for mobile or other things like cards and sidebars.
2
+
3
+ ### Responsive `display` and `full_width`
4
+
5
+ `full_width` applies block styling that includes `display: flex` on the **same element** as the button. The **`display` global prop** also sets `display` (via utility classes, often with `!important`).
6
+
7
+ Putting **both** on one button means **two systems control `display` on one node**, which can cause wrong visibility (e.g. both a header and a full-width mobile button showing) or confusing cascade behavior.
8
+
9
+ **Recommended:** Put responsive `display` on a **parent** (e.g. `Flex`, `Card`, or a plain wrapper) and keep `fullWidth` only on the `Button` inside. The wrapper handles show/hide by breakpoint; the button only handles full-width layout.
10
+
11
+ ```jsx
12
+ import { Flex, Button } from "playbook-ui"
13
+
14
+ const Example = () => (
15
+ <Flex
16
+ display={{ xs: "flex", default: "none" }}
17
+ orientation="column"
18
+ width="100%"
19
+ >
20
+ <Button fullWidth text="Add" />
21
+ </Flex>
22
+ )
23
+ ```
@@ -0,0 +1,109 @@
1
+ <%
2
+ tree_base = [{
3
+ label: "Power Home Remodeling",
4
+ value: "powerHomeRemodeling",
5
+ id: "100",
6
+ expanded: true,
7
+ children: [
8
+ {
9
+ label: "People",
10
+ value: "people",
11
+ id: "101",
12
+ expanded: true,
13
+ children: [
14
+ {
15
+ label: "Talent Acquisition",
16
+ value: "talentAcquisition",
17
+ id: "102",
18
+ },
19
+ {
20
+ label: "Business Affairs",
21
+ value: "business Affairs",
22
+ id: "103",
23
+ children: [
24
+ {
25
+ label: "Initiatives",
26
+ value: "initiatives",
27
+ id: "104",
28
+ },
29
+ {
30
+ label: "Learning & Development",
31
+ value: "learningAndDevelopment",
32
+ id: "105",
33
+ },
34
+ ],
35
+ },
36
+ {
37
+ label: "People Experience",
38
+ value: "peopleExperience",
39
+ id: "106",
40
+ },
41
+ ],
42
+ },
43
+ {
44
+ label: "Contact Center",
45
+ value: "contactCenter",
46
+ id: "107",
47
+ children: [
48
+ {
49
+ label: "Appointment Management",
50
+ value: "appointmentManagement",
51
+ id: "108",
52
+ },
53
+ {
54
+ label: "Customer Service",
55
+ value: "customerService",
56
+ id: "109",
57
+ },
58
+ {
59
+ label: "Energy",
60
+ value: "energy",
61
+ id: "110",
62
+ },
63
+ ],
64
+ },
65
+ ],
66
+ }]
67
+
68
+ prefix_mls_ids = nil
69
+ prefix_mls_ids = ->(nodes, pfx) {
70
+ nodes.map do |n|
71
+ h = n.dup
72
+ h[:id] = "#{pfx}#{n[:id]}"
73
+ h[:children] = prefix_mls_ids.call(n[:children], pfx) if n[:children].present?
74
+ h
75
+ end
76
+ }
77
+
78
+ tree_multi = prefix_mls_ids.call(tree_base, "phm_")
79
+ tree_return_all = prefix_mls_ids.call(tree_base, "phr_")
80
+ tree_single = prefix_mls_ids.call(tree_base, "phs_")
81
+ %>
82
+
83
+ <%= pb_rails("multi_level_select", props: {
84
+ id: "multi-level-select-placeholder-multi-rails",
85
+ label: "Multi (default)",
86
+ margin_bottom: "sm",
87
+ name: "placeholder_multi",
88
+ tree_data: tree_multi,
89
+ placeholder: "Search or choose options…",
90
+ }) %>
91
+
92
+ <%= pb_rails("multi_level_select", props: {
93
+ id: "multi-level-select-placeholder-return-all-rails",
94
+ label: "Multi (return all selected)",
95
+ margin_bottom: "sm",
96
+ name: "placeholder_return_all",
97
+ placeholder: "Departments...",
98
+ return_all_selected: true,
99
+ tree_data: tree_return_all,
100
+ }) %>
101
+
102
+ <%= pb_rails("multi_level_select", props: {
103
+ id: "multi-level-select-placeholder-single-rails",
104
+ label: "Single",
105
+ name: "placeholder_single",
106
+ placeholder: "Select one option…",
107
+ tree_data: tree_single,
108
+ variant: "single",
109
+ }) %>
@@ -0,0 +1,127 @@
1
+ import React from "react";
2
+
3
+ import MultiLevelSelect from "../_multi_level_select";
4
+
5
+ const treeTemplate = [
6
+ {
7
+ label: "Power Home Remodeling",
8
+ value: "powerHomeRemodeling",
9
+ id: "powerhome1",
10
+ expanded: true,
11
+ children: [
12
+ {
13
+ label: "People",
14
+ value: "people",
15
+ id: "people1",
16
+ expanded: true,
17
+ children: [
18
+ {
19
+ label: "Talent Acquisition",
20
+ value: "talentAcquisition",
21
+ id: "talent1",
22
+ },
23
+ {
24
+ label: "Business Affairs",
25
+ value: "businessAffairs",
26
+ id: "business1",
27
+ children: [
28
+ {
29
+ label: "Initiatives",
30
+ value: "initiatives",
31
+ id: "initiative1",
32
+ },
33
+ {
34
+ label: "Learning & Development",
35
+ value: "learningAndDevelopment",
36
+ id: "development1",
37
+ },
38
+ ],
39
+ },
40
+ {
41
+ label: "People Experience",
42
+ value: "peopleExperience",
43
+ id: "experience1",
44
+ },
45
+ ],
46
+ },
47
+ {
48
+ label: "Contact Center",
49
+ value: "contactCenter",
50
+ id: "contact1",
51
+ children: [
52
+ {
53
+ label: "Appointment Management",
54
+ value: "appointmentManagement",
55
+ id: "appointment1",
56
+ },
57
+ {
58
+ label: "Customer Service",
59
+ value: "customerService",
60
+ id: "customer1",
61
+ },
62
+ {
63
+ label: "Energy",
64
+ value: "energy",
65
+ id: "energy1",
66
+ },
67
+ ],
68
+ },
69
+ ],
70
+ },
71
+ ];
72
+
73
+ function prefixTreeIds(nodes, prefix) {
74
+ return nodes.map((node) => ({
75
+ ...node,
76
+ id: `${prefix}${node.id}`,
77
+ children:
78
+ node.children && node.children.length > 0
79
+ ? prefixTreeIds(node.children, prefix)
80
+ : node.children,
81
+ }));
82
+ }
83
+
84
+ const treeDataMulti = prefixTreeIds(treeTemplate, "phm_");
85
+ const treeDataReturnAll = prefixTreeIds(treeTemplate, "phr_");
86
+ const treeDataSingle = prefixTreeIds(treeTemplate, "phs_");
87
+
88
+ const MultiLevelSelectPlaceholder = () => (
89
+ <>
90
+ <MultiLevelSelect
91
+ id="multi-level-select-placeholder-multi"
92
+ label="Multi (default)"
93
+ marginBottom="sm"
94
+ name="placeholder_multi"
95
+ onSelect={(selectedNodes) =>
96
+ console.log("Multi — default", selectedNodes)
97
+ }
98
+ placeholder="Search or choose options…"
99
+ treeData={treeDataMulti}
100
+ />
101
+ <MultiLevelSelect
102
+ id="multi-level-select-placeholder-return-all"
103
+ label="Multi (return all selected)"
104
+ marginBottom="sm"
105
+ name="placeholder_return_all"
106
+ onSelect={(selectedNodes) =>
107
+ console.log("Multi — return all selected", selectedNodes)
108
+ }
109
+ placeholder="Departments..."
110
+ returnAllSelected
111
+ treeData={treeDataReturnAll}
112
+ />
113
+ <MultiLevelSelect
114
+ id="multi-level-select-placeholder-single"
115
+ label="Single"
116
+ name="placeholder_single"
117
+ onSelect={(selectedNodes) =>
118
+ console.log("Single", selectedNodes)
119
+ }
120
+ placeholder="Select one option…"
121
+ treeData={treeDataSingle}
122
+ variant="single"
123
+ />
124
+ </>
125
+ );
126
+
127
+ export default MultiLevelSelectPlaceholder;
@@ -0,0 +1 @@
1
+ Use the `placeholder` prop to customize the initial text shown in the input when nothing is selected. The default is `Start typing...`.
@@ -18,6 +18,7 @@ examples:
18
18
  - multi_level_select_disabled_options_parent: Disabled Parent Option (Return All Selected)
19
19
  - multi_level_select_single_disabled: Disabled Options (Single Select)
20
20
  - multi_level_select_required_indicator: Required Indicator
21
+ - multi_level_select_placeholder: Placeholder
21
22
 
22
23
  react:
23
24
  - multi_level_select_default: Default
@@ -40,3 +41,4 @@ examples:
40
41
  - multi_level_select_single_disabled: Disabled Options (Single Select)
41
42
  - multi_level_select_required_indicator: Required Indicator
42
43
  - multi_level_select_react_reset_key: Reset with Key (React)
44
+ - multi_level_select_placeholder: Placeholder
@@ -18,3 +18,4 @@ export { default as MultiLevelSelectLabel } from "./_multi_level_select_label.js
18
18
  export { default as MultiLevelSelectSingleDisabled } from "./_multi_level_select_single_disabled.jsx"
19
19
  export { default as MultiLevelSelectRequiredIndicator } from "./_multi_level_select_required_indicator.jsx"
20
20
  export { default as MultiLevelSelectReactResetKey } from "./_multi_level_select_react_reset_key.jsx"
21
+ export { default as MultiLevelSelectPlaceholder } from "./_multi_level_select_placeholder.jsx"
@@ -55,6 +55,7 @@ sections:
55
55
  - table_with_clickable_rows
56
56
  - table_with_selectable_rows
57
57
  - table_with_filter_variant
58
+ - table_with_filter_variant_external_filter_rails
58
59
  - table_with_filter_variant_with_pagination
59
60
  - table_disable_hover
60
61
 
@@ -0,0 +1,45 @@
1
+ <%# External filter: capture any filter markup and pass it via the filter prop.
2
+ Use your own helper (e.g. a search/filter form) or pb_rails("filter") as shown here. %>
3
+ <% users = [
4
+ { name: "Alex", role: "Engineer" },
5
+ { name: "Sam", role: "Designer" },
6
+ { name: "Jordan", role: "Manager" },
7
+ ] %>
8
+
9
+ <% filter_output = capture do %>
10
+ <%= pb_rails("filter", props: {
11
+ id: "external-filter-demo",
12
+ template: "single",
13
+ results: 3,
14
+ background: false,
15
+ sort_menu: [
16
+ { item: "Name", link: "#", active: true, direction: "asc" },
17
+ { item: "Role", link: "#", active: false },
18
+ ],
19
+ }) do %>
20
+ <%= pb_rails("text_input", props: { label: "Name", placeholder: "Search by name" }) %>
21
+ <%= pb_rails("text_input", props: { label: "Role", placeholder: "e.g. Engineer, Designer" }) %>
22
+ <%= pb_rails("button", props: { text: "Apply" }) %>
23
+ <% end %>
24
+ <% end %>
25
+
26
+ <%= pb_rails("table", props: {
27
+ variant: "with_filter",
28
+ title: "Table with External Filter",
29
+ filter: filter_output,
30
+ }) do %>
31
+ <%= pb_rails("table/table_head") do %>
32
+ <%= pb_rails("table/table_row") do %>
33
+ <%= pb_rails("table/table_header", props: { text: "Name" }) %>
34
+ <%= pb_rails("table/table_header", props: { text: "Role" }) %>
35
+ <% end %>
36
+ <% end %>
37
+ <%= pb_rails("table/table_body") do %>
38
+ <% users.each do |user| %>
39
+ <%= pb_rails("table/table_row") do %>
40
+ <%= pb_rails("table/table_cell") { user[:name] } %>
41
+ <%= pb_rails("table/table_cell") { user[:role] } %>
42
+ <% end %>
43
+ <% end %>
44
+ <% end %>
45
+ <% end %>
@@ -0,0 +1,39 @@
1
+ Use the **"with_filter"** variant with an **external filter** (Option B): pass pre-rendered filter markup via the `filter` prop. Same layout as Variant with Filter (card, title, separator, flex); only the filter slot is supplied by you. Use this when you need:
2
+
3
+ - **Manual filter submission** – Apply / Filter button instead of automatic application
4
+ - **Full control** – Over filter props, template, sort menu, and submission
5
+ - **Custom or app-specific filter helpers** – Any helper that returns filter markup (e.g. search/filter forms)
6
+
7
+ #### Required props
8
+
9
+ - `variant: "with_filter"`
10
+ - `filter` – Pre-rendered filter HTML (e.g. from `capture { ... }`)
11
+
12
+ When `filter` is present, `filter_content` and `filter_props` are ignored.
13
+
14
+ #### How to do it
15
+
16
+ 1. **Render your filter** (e.g. `pb_rails("filter", ...)` or any helper that returns filter markup).
17
+ 2. **Capture the output** with `capture do ... end`.
18
+ 3. **Pass it to the Table** as the `filter` prop.
19
+
20
+ **Example (generic pattern):**
21
+
22
+ ```erb
23
+ <% filter_output = capture do %>
24
+ <%= pb_rails("filter", props: { template: "single", results: 10, background: false }) do %>
25
+ <%= pb_rails("text_input", props: { label: "Name", placeholder: "Search by name" }) %>
26
+ <%= pb_rails("button", props: { text: "Apply" }) %>
27
+ <% end %>
28
+ <% end %>
29
+
30
+ <%= pb_rails("table", props: {
31
+ variant: "with_filter",
32
+ title: "My Table",
33
+ filter: filter_output,
34
+ }) do %>
35
+ <%# table_head / table_body ... %>
36
+ <% end %>
37
+ ```
38
+
39
+ For Nitro apps that use a shared search/filter pattern, reference the example on Alpha for implementation details.
@@ -26,8 +26,9 @@ The Table kit automatically sets these Filter defaults (which you can override v
26
26
  - `min_width: "xs"`
27
27
  - `popover_props: { width: "350px" }`
28
28
 
29
+ Alternatively, you can pass pre-rendered filter markup via the `filter` prop (e.g. for manual submission or custom filter helpers)—scroll down for that approach.
29
30
 
30
31
  **IMPORTANT NOTE**:
31
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.
32
33
 
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).
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 as seen [here](https://playbook.powerapp.cloud/building_blocks/table_filter_card/rails).
@@ -41,6 +41,7 @@ examples:
41
41
  - table_with_header_style_borderless: Header Style Borderless
42
42
  - table_with_header_style_floating: Header Style Floating
43
43
  - table_with_filter_variant_rails: Variant with Filter
44
+ - table_with_filter_variant_external_filter_rails: Variant with Filter (External Filter)
44
45
  - table_with_filter_variant_with_pagination_rails: Variant with Filter and Pagination
45
46
  - table_with_filter_with_card_title_props_rails: Variant with Filter (with Card and Title Props)
46
47
 
@@ -1,4 +1,3 @@
1
- /* eslint-disable react/no-danger */
2
1
  /* eslint-disable react/no-multi-comp */
3
2
 
4
3
  import React, { useState } from 'react'
@@ -38,14 +37,26 @@ const TypeaheadWithHighlight = (props) => {
38
37
  const [selectedUser, setSelectedUser] = useState()
39
38
 
40
39
  const formatOptionLabel = ({name, territory, title}, {inputValue}) => {
40
+ const escapeRegExp = (value = "") => (
41
+ value.replace(/[.*+?^${}()|[\]\\]/g, "\\$&")
42
+ )
41
43
 
42
- const highlighted = (text) => {
44
+ const highlighted = (text = "") => {
43
45
  if (!inputValue.length) return text
44
- return text.replace(
45
- new RegExp(inputValue, 'gi'),
46
- (highlighted) => `<mark>${highlighted}</mark>`
47
- )
46
+
47
+ const escapedInputValue = escapeRegExp(inputValue)
48
+ const regex = new RegExp(`(${escapedInputValue})`, 'gi')
49
+ const parts = text.split(regex)
50
+
51
+ return parts.map((part, index) => {
52
+ if (part.toLowerCase() === inputValue.toLowerCase()) {
53
+ return <mark key={`${part}-${index}`}>{part}</mark>
54
+ }
55
+
56
+ return <React.Fragment key={`${part}-${index}`}>{part}</React.Fragment>
57
+ })
48
58
  }
59
+
49
60
  return (
50
61
  <Flex>
51
62
  <FlexItem>
@@ -61,11 +72,12 @@ const TypeaheadWithHighlight = (props) => {
61
72
  size={4}
62
73
  {...props}
63
74
  >
64
- <span dangerouslySetInnerHTML={{ __html: highlighted(name) }} /></Title>
75
+ {highlighted(name)}
76
+ </Title>
65
77
  <Body color="light"
66
78
  {...props}
67
79
  >
68
- <span dangerouslySetInnerHTML={{ __html: highlighted(title) }} />{" • "}
80
+ {highlighted(title)}{" • "}
69
81
  {territory}
70
82
  </Body>
71
83
  </FlexItem>
@@ -0,0 +1,3 @@
1
+ Use `formatOptionLabel` to customize each option row and highlight text that matches the current search input. Split each field (for example, `name` and `title`) by the typed value, then render matching parts inside `<mark>` so users can quickly see why a result matched.
2
+
3
+ See the code snippet below for more details.
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: 16.4.0.pre.alpha.PLAY2718containerfalseborderradiusresponsiveonly15164
4
+ version: 16.4.0.pre.alpha.PLAY2846reactadvancedtablecalcheaderpinnedrows15356
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: 2026-03-23 00:00:00.000000000 Z
12
+ date: 2026-03-31 00:00:00.000000000 Z
13
13
  dependencies:
14
14
  - !ruby/object:Gem::Dependency
15
15
  name: playbook_ui
@@ -309,7 +309,8 @@ files:
309
309
  - app/pb_kits/playbook/pb_button/docs/_button_form.jsx
310
310
  - app/pb_kits/playbook/pb_button/docs/_button_full_width.html.erb
311
311
  - app/pb_kits/playbook/pb_button/docs/_button_full_width.jsx
312
- - app/pb_kits/playbook/pb_button/docs/_button_full_width.md
312
+ - app/pb_kits/playbook/pb_button/docs/_button_full_width_rails.md
313
+ - app/pb_kits/playbook/pb_button/docs/_button_full_width_react.md
313
314
  - app/pb_kits/playbook/pb_button/docs/_button_full_width_swift.md
314
315
  - app/pb_kits/playbook/pb_button/docs/_button_hover.html.erb
315
316
  - app/pb_kits/playbook/pb_button/docs/_button_hover.jsx
@@ -1461,6 +1462,9 @@ files:
1461
1462
  - app/pb_kits/playbook/pb_multi_level_select/docs/_multi_level_select_label.html.erb
1462
1463
  - app/pb_kits/playbook/pb_multi_level_select/docs/_multi_level_select_label.jsx
1463
1464
  - app/pb_kits/playbook/pb_multi_level_select/docs/_multi_level_select_label.md
1465
+ - app/pb_kits/playbook/pb_multi_level_select/docs/_multi_level_select_placeholder.html.erb
1466
+ - app/pb_kits/playbook/pb_multi_level_select/docs/_multi_level_select_placeholder.jsx
1467
+ - app/pb_kits/playbook/pb_multi_level_select/docs/_multi_level_select_placeholder.md
1464
1468
  - app/pb_kits/playbook/pb_multi_level_select/docs/_multi_level_select_react_hook.jsx
1465
1469
  - app/pb_kits/playbook/pb_multi_level_select/docs/_multi_level_select_react_hook.md
1466
1470
  - app/pb_kits/playbook/pb_multi_level_select/docs/_multi_level_select_react_reset_key.jsx
@@ -2300,6 +2304,8 @@ files:
2300
2304
  - app/pb_kits/playbook/pb_table/docs/_table_with_dynamic_collapsible_react.md
2301
2305
  - app/pb_kits/playbook/pb_table/docs/_table_with_filter_variant.jsx
2302
2306
  - app/pb_kits/playbook/pb_table/docs/_table_with_filter_variant.md
2307
+ - app/pb_kits/playbook/pb_table/docs/_table_with_filter_variant_external_filter_rails.html.erb
2308
+ - app/pb_kits/playbook/pb_table/docs/_table_with_filter_variant_external_filter_rails.md
2303
2309
  - app/pb_kits/playbook/pb_table/docs/_table_with_filter_variant_rails.html.erb
2304
2310
  - app/pb_kits/playbook/pb_table/docs/_table_with_filter_variant_rails.md
2305
2311
  - app/pb_kits/playbook/pb_table/docs/_table_with_filter_variant_with_pagination.jsx
@@ -2656,6 +2662,7 @@ files:
2656
2662
  - app/pb_kits/playbook/pb_typeahead/docs/_typeahead_truncated_text.md
2657
2663
  - app/pb_kits/playbook/pb_typeahead/docs/_typeahead_with_context.html.erb
2658
2664
  - app/pb_kits/playbook/pb_typeahead/docs/_typeahead_with_highlight.jsx
2665
+ - app/pb_kits/playbook/pb_typeahead/docs/_typeahead_with_highlight.md
2659
2666
  - app/pb_kits/playbook/pb_typeahead/docs/_typeahead_with_pills.html.erb
2660
2667
  - app/pb_kits/playbook/pb_typeahead/docs/_typeahead_with_pills.jsx
2661
2668
  - app/pb_kits/playbook/pb_typeahead/docs/_typeahead_with_pills.md
@@ -1 +0,0 @@
1
- This button is used many times for mobile or other things like cards and sidebars.