playbook_ui_docs 16.4.0 → 16.5.0.pre.alpha.RTEPOC15682

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 (50) hide show
  1. checksums.yaml +4 -4
  2. data/app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_grouped_headers_composition.jsx +235 -0
  3. data/app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_grouped_headers_composition.md +17 -0
  4. data/app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_pinned_rows_rails.html.erb +57 -0
  5. data/app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_pinned_rows_rails.md +7 -0
  6. data/app/pb_kits/playbook/pb_advanced_table/docs/advanced_table_grouped_headers_composition_mock_data.json +98 -0
  7. data/app/pb_kits/playbook/pb_advanced_table/docs/example.yml +2 -0
  8. data/app/pb_kits/playbook/pb_advanced_table/docs/index.js +1 -0
  9. data/app/pb_kits/playbook/pb_button/docs/_button_full_width_rails.md +19 -0
  10. data/app/pb_kits/playbook/pb_button/docs/_button_full_width_react.md +23 -0
  11. data/app/pb_kits/playbook/pb_button/docs/{_button_loading.html.erb → _button_loading_rails.html.erb} +5 -5
  12. data/app/pb_kits/playbook/pb_button/docs/_button_loading_rails.md +3 -0
  13. data/app/pb_kits/playbook/pb_button/docs/example.yml +1 -1
  14. data/app/pb_kits/playbook/pb_dialog/docs/_dialog_default.html.erb +9 -18
  15. data/app/pb_kits/playbook/pb_dialog/docs/_dialog_default.jsx +5 -24
  16. data/app/pb_kits/playbook/pb_multi_level_select/docs/_multi_level_select_placeholder.html.erb +109 -0
  17. data/app/pb_kits/playbook/pb_multi_level_select/docs/_multi_level_select_placeholder.jsx +127 -0
  18. data/app/pb_kits/playbook/pb_multi_level_select/docs/_multi_level_select_placeholder.md +1 -0
  19. data/app/pb_kits/playbook/pb_multi_level_select/docs/example.yml +2 -0
  20. data/app/pb_kits/playbook/pb_multi_level_select/docs/index.js +1 -0
  21. data/app/pb_kits/playbook/pb_rich_text_editor/docs/_rich_text_editor_rails_default.html.erb +1 -0
  22. data/app/pb_kits/playbook/pb_rich_text_editor/docs/_rich_text_editor_rails_default.md +1 -0
  23. data/app/pb_kits/playbook/pb_rich_text_editor/docs/example.yml +1 -0
  24. data/app/pb_kits/playbook/pb_select/docs/_select_attributes.html.erb +1 -0
  25. data/app/pb_kits/playbook/pb_select/docs/_select_blank.html.erb +1 -0
  26. data/app/pb_kits/playbook/pb_select/docs/_select_custom_select.html.erb +1 -1
  27. data/app/pb_kits/playbook/pb_select/docs/_select_custom_select_subheaders.html.erb +1 -1
  28. data/app/pb_kits/playbook/pb_select/docs/_select_default.html.erb +1 -0
  29. data/app/pb_kits/playbook/pb_select/docs/_select_disabled.html.erb +1 -0
  30. data/app/pb_kits/playbook/pb_select/docs/_select_disabled_options.html.erb +1 -0
  31. data/app/pb_kits/playbook/pb_select/docs/_select_error.html.erb +1 -0
  32. data/app/pb_kits/playbook/pb_select/docs/_select_inline.html.erb +1 -0
  33. data/app/pb_kits/playbook/pb_select/docs/_select_inline_compact.html.erb +1 -0
  34. data/app/pb_kits/playbook/pb_select/docs/_select_inline_show_arrow.html.erb +1 -0
  35. data/app/pb_kits/playbook/pb_select/docs/_select_multiple.html.erb +1 -0
  36. data/app/pb_kits/playbook/pb_select/docs/_select_required.html.erb +1 -0
  37. data/app/pb_kits/playbook/pb_select/docs/_select_required_indicator.html.erb +1 -0
  38. data/app/pb_kits/playbook/pb_select/docs/_select_value_text_same.html.erb +1 -0
  39. data/app/pb_kits/playbook/pb_table/docs/_sections.yml +1 -0
  40. data/app/pb_kits/playbook/pb_table/docs/_table_with_filter_variant_external_filter_rails.html.erb +45 -0
  41. data/app/pb_kits/playbook/pb_table/docs/_table_with_filter_variant_external_filter_rails.md +39 -0
  42. data/app/pb_kits/playbook/pb_table/docs/_table_with_filter_variant_rails.md +2 -1
  43. data/app/pb_kits/playbook/pb_table/docs/example.yml +1 -0
  44. data/app/pb_kits/playbook/pb_typeahead/docs/_typeahead_createable.html.erb +29 -0
  45. data/app/pb_kits/playbook/pb_typeahead/docs/_typeahead_createable.md +1 -0
  46. data/app/pb_kits/playbook/pb_typeahead/docs/_typeahead_with_highlight.jsx +20 -8
  47. data/app/pb_kits/playbook/pb_typeahead/docs/_typeahead_with_highlight.md +3 -0
  48. data/app/pb_kits/playbook/pb_typeahead/docs/example.yml +1 -0
  49. metadata +21 -4
  50. data/app/pb_kits/playbook/pb_button/docs/_button_full_width.md +0 -1
@@ -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"
@@ -0,0 +1 @@
1
+ <%= pb_rails("rich_text_editor", props: { input_options: { id: 'hidden_input_id', name: "hidden_input_name" }, value: "Add your text here. You can format your text, add links, quotes, and bullets." }) %>
@@ -0,0 +1 @@
1
+ TipTap (vanilla JS) — the Playbook **Rails** rich text editor. No React; same editor core as the React TipTap variant. Content is synced to a hidden input for Rails form submission. Use `pb_rails("rich_text_editor", props: { input_options: { id: "...", name: "..." }, value: "..." })`.
@@ -1,6 +1,7 @@
1
1
  examples:
2
2
 
3
3
  rails:
4
+ - rich_text_editor_rails_default: "Rails (TipTap)"
4
5
 
5
6
  react:
6
7
  - rich_text_editor_advanced_default: Advanced Default
@@ -1,4 +1,5 @@
1
1
  <%= pb_rails("select", props: {
2
+ id: "select-food-attributes",
2
3
  attributes: {
3
4
  data: { options: "data_attribute" },
4
5
  },
@@ -1,4 +1,5 @@
1
1
  <%= pb_rails("select", props: {
2
+ id: "select-location",
2
3
  label: "Where do you live",
3
4
  name: "location",
4
5
  blank_selection: "Select One...",
@@ -1,4 +1,4 @@
1
- <%= pb_rails("select", props: { label: "Favorite Holiday" }) do %>
1
+ <%= pb_rails("select", props: { id: "holiday", label: "Favorite Holiday" }) do %>
2
2
  <select name="holiday" id="holiday">
3
3
  <option value="1">Christmas</option>
4
4
  <option value="2">Thanksgiving</option>
@@ -1,4 +1,4 @@
1
- <%= pb_rails("select", props: { label: "Favorite Animal" }) do %>
1
+ <%= pb_rails("select", props: { id: "animal", label: "Favorite Animal" }) do %>
2
2
  <select name="animal" id="animal">
3
3
  <optgroup label="Mammal">
4
4
  <option value="1">Cat</option>
@@ -1,4 +1,5 @@
1
1
  <%= pb_rails("select", props: {
2
+ id: "select-favorite-food",
2
3
  label: "Favorite Food",
3
4
  name: "food",
4
5
  options: [
@@ -1,4 +1,5 @@
1
1
  <%= pb_rails("select", props: {
2
+ id: "select-dessert-disabled",
2
3
  label: "Favorite Dessert",
3
4
  disabled: true,
4
5
  name: "dessert",
@@ -1,4 +1,5 @@
1
1
  <%= pb_rails("select", props: {
2
+ id: "select-coffee",
2
3
  label: "Favorite Coffee",
3
4
  name: "coffee",
4
5
  options: [
@@ -1,5 +1,6 @@
1
1
  <%= pb_rails("select", props: {
2
2
  error: raw(pb_rails("icon", props: { icon: "warning" }) + " Please make a valid selection"),
3
+ id: "select-food-error",
3
4
  label: "Favorite Food",
4
5
  name: "food",
5
6
  options: [
@@ -1,4 +1,5 @@
1
1
  <%= pb_rails("select", props: {
2
+ id: "select-food-inline",
2
3
  label: "Favorite Food",
3
4
  name: "food",
4
5
  inline: true,
@@ -1,4 +1,5 @@
1
1
  <%= pb_rails("select", props: {
2
+ id: "select-food-inline-compact",
2
3
  label: "Favorite Food",
3
4
  name: "food",
4
5
  inline: true,
@@ -1,4 +1,5 @@
1
1
  <%= pb_rails("select", props: {
2
+ id: "select-food-inline-arrow",
2
3
  label: "Favorite Food",
3
4
  name: "food",
4
5
  inline: true,
@@ -1,4 +1,5 @@
1
1
  <%= pb_rails("select", props: {
2
+ id: "select-food-multiple",
2
3
  label: "Favorite Food",
3
4
  name: "food",
4
5
  multiple: true,
@@ -1,4 +1,5 @@
1
1
  <%= pb_rails("select", props: {
2
+ id: "select-shoe-required",
2
3
  label: "Which shoe do you tie first?",
3
4
  required: true,
4
5
  name: "shoe",
@@ -1,4 +1,5 @@
1
1
  <%= pb_rails("select", props: {
2
+ id: "select-snacks-required-indicator",
2
3
  label: "Favorite Snacks",
3
4
  name: "food",
4
5
  required_indicator: true,
@@ -1,4 +1,5 @@
1
1
  <%= pb_rails("select", props: {
2
+ id: "select-sport",
2
3
  label: "Favorite Sport",
3
4
  name: "sports",
4
5
  options: [
@@ -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
 
@@ -0,0 +1,29 @@
1
+ <%
2
+ options = [
3
+ { label: 'Orange', value: '#FFA500' },
4
+ { label: 'Red', value: '#FF0000' },
5
+ { label: 'Green', value: '#00FF00' },
6
+ { label: 'Blue', value: '#0000FF' },
7
+ ]
8
+ %>
9
+
10
+ <%= pb_rails("typeahead", props: {
11
+ id: "typeahead-creatable",
12
+ placeholder: "All Colors",
13
+ options: options,
14
+ label: "Colors",
15
+ name: :foo,
16
+ createable: true,
17
+ pills: true,
18
+ })
19
+ %>
20
+
21
+ <%= javascript_tag defer: "defer" do %>
22
+ document.addEventListener("pb-typeahead-kit-typeahead-creatable-result-option-select", function(event) {
23
+ console.log('Single Option selected')
24
+ console.dir(event.detail)
25
+ })
26
+ document.addEventListener("pb-typeahead-kit-typeahead-creatable-result-clear", function() {
27
+ console.log('All options cleared')
28
+ })
29
+ <% end %>
@@ -0,0 +1 @@
1
+ The `createable` prop allows users to create new options by typing a value that doesn't exist in the options list.
@@ -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.
@@ -11,6 +11,7 @@ examples:
11
11
  - typeahead_with_pills_async_users: With Pills (Async Data w/ Users)
12
12
  - typeahead_inline: Inline
13
13
  - typeahead_multi_kit: Multi Kit Options
14
+ - typeahead_createable: Createable
14
15
  - typeahead_error_state: Error State
15
16
  - typeahead_margin_bottom: Margin Bottom
16
17
  - typeahead_with_pills_color: With Pills (Custom Color)