Skip to content

Commit 9058dc3

Browse files
committed
Generating static files
1 parent 26783e5 commit 9058dc3

File tree

4 files changed

+202
-6
lines changed

4 files changed

+202
-6
lines changed

static/arguments.json

Lines changed: 86 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -674,7 +674,7 @@
674674
"name": "scheme",
675675
"type": "Symbol",
676676
"default": "`:default`",
677-
"description": "One of `:danger`, `:default`, `:success`, or `:warning`."
677+
"description": "One of `:danger`, `:default`, `:success`, `:upsell`, or `:warning`."
678678
},
679679
{
680680
"name": "system_arguments",
@@ -2344,11 +2344,95 @@
23442344
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/select_panel.rb",
23452345
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/select_panel/default/",
23462346
"parameters": [
2347+
{
2348+
"name": "src",
2349+
"type": "String",
2350+
"default": "`nil`",
2351+
"description": "The URL to fetch search results from."
2352+
},
2353+
{
2354+
"name": "title",
2355+
"type": "String",
2356+
"default": "`\"Menu\"`",
2357+
"description": "The title that appears at the top of the panel."
2358+
},
2359+
{
2360+
"name": "id",
2361+
"type": "String",
2362+
"default": "`self.class.generate_id`",
2363+
"description": "The unique ID of the panel."
2364+
},
2365+
{
2366+
"name": "size",
2367+
"type": "Symbol",
2368+
"default": "`:small`",
2369+
"description": "The size of the panel. One of `:auto`, `:large`, `:medium`, `:medium_portrait`, `:small`, or `:xlarge`."
2370+
},
2371+
{
2372+
"name": "select_variant",
2373+
"type": "Symbol",
2374+
"default": "`:single`",
2375+
"description": "One of `:multiple`, `:none`, or `:single`."
2376+
},
2377+
{
2378+
"name": "fetch_strategy",
2379+
"type": "Symbol",
2380+
"default": "`:remote`",
2381+
"description": "One of `:eventually_local`, `:local`, or `:remote`."
2382+
},
2383+
{
2384+
"name": "no_results_label",
2385+
"type": "String",
2386+
"default": "`\"No results found\"`",
2387+
"description": "The label to display when no results are found."
2388+
},
2389+
{
2390+
"name": "preload",
2391+
"type": "Boolean",
2392+
"default": "`false`",
2393+
"description": "Whether to preload search results when the page loads. If this option is false, results are loaded when the panel is opened."
2394+
},
2395+
{
2396+
"name": "dynamic_label",
2397+
"type": "Boolean",
2398+
"default": "`false`",
2399+
"description": "Whether or not to display the text of the currently selected item in the show button."
2400+
},
2401+
{
2402+
"name": "dynamic_label_prefix",
2403+
"type": "String",
2404+
"default": "`nil`",
2405+
"description": "If provided, the prefix is prepended to the dynamic label and displayed in the show button."
2406+
},
2407+
{
2408+
"name": "dynamic_aria_label_prefix",
2409+
"type": "String",
2410+
"default": "`nil`",
2411+
"description": "If provided, the prefix is prepended to the dynamic label and set as the value of the `aria-label` attribute on the show button."
2412+
},
2413+
{
2414+
"name": "body_id",
2415+
"type": "String",
2416+
"default": "`nil`",
2417+
"description": "The unique ID of the panel body. If not provided, the body ID will be set to the panel ID with a \"-body\" suffix."
2418+
},
2419+
{
2420+
"name": "list_arguments",
2421+
"type": "Hash",
2422+
"default": "`{}`",
2423+
"description": "Arguments to pass to the underlying [ActionList](/components/alpha/actionlist) component. Only has an effect for the local fetch strategy."
2424+
},
2425+
{
2426+
"name": "form_arguments",
2427+
"type": "Hash",
2428+
"default": "`{}`",
2429+
"description": "Form arguments. Supported for `local`, and experimentally supported for `remote` and `eventually_local` strategies by enabling the `use_experimental_non_local_form` flag."
2430+
},
23472431
{
23482432
"name": "use_experimental_non_local_form",
23492433
"type": "Boolean",
23502434
"default": "`false`",
2351-
"description": "A feature flag used to slowly roll out moving the input field (generated from form arguments) to the top of the SelectPanel HTML thus allowing remote fetching to have default form values."
2435+
"description": "A feature flag used to slowly roll out moving the input field (generated from form arguments) to the top of the SelectPanel HTML thus allowing remote fetching to have default form values. At this time, support is only available for the :single select variant. See: https://github.com/github/primer/issues/4923."
23522436
},
23532437
{
23542438
"name": "show_filter",

static/constants.json

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,8 @@
197197
"default": "bell",
198198
"warning": "alert",
199199
"danger": "stop",
200-
"success": "check-circle"
200+
"success": "check-circle",
201+
"upsell": "info"
201202
},
202203
"DEFAULT_SCHEME": "default",
203204
"DEFAULT_TAG": "div",
@@ -217,7 +218,8 @@
217218
"default": "",
218219
"warning": "Banner--warning",
219220
"danger": "Banner--error",
220-
"success": "Banner--success"
221+
"success": "Banner--success",
222+
"upsell": "Banner--upsell"
221223
},
222224
"TAG_OPTIONS": [
223225
"div",

static/info_arch.json

Lines changed: 99 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2483,7 +2483,7 @@
24832483
"name": "scheme",
24842484
"type": "Symbol",
24852485
"default": "`:default`",
2486-
"description": "One of `:danger`, `:default`, `:success`, or `:warning`."
2486+
"description": "One of `:danger`, `:default`, `:success`, `:upsell`, or `:warning`."
24872487
},
24882488
{
24892489
"name": "system_arguments",
@@ -2583,6 +2583,19 @@
25832583
]
25842584
}
25852585
},
2586+
{
2587+
"preview_path": "primer/alpha/banner/scheme_upsell",
2588+
"name": "scheme_upsell",
2589+
"snapshot": "true",
2590+
"skip_rules": {
2591+
"wont_fix": [
2592+
"region"
2593+
],
2594+
"will_fix": [
2595+
"color-contrast"
2596+
]
2597+
}
2598+
},
25862599
{
25872600
"preview_path": "primer/alpha/banner/dismissible",
25882601
"name": "dismissible",
@@ -7450,11 +7463,95 @@
74507463
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/select_panel.rb",
74517464
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/select_panel/default/",
74527465
"parameters": [
7466+
{
7467+
"name": "src",
7468+
"type": "String",
7469+
"default": "`nil`",
7470+
"description": "The URL to fetch search results from."
7471+
},
7472+
{
7473+
"name": "title",
7474+
"type": "String",
7475+
"default": "`\"Menu\"`",
7476+
"description": "The title that appears at the top of the panel."
7477+
},
7478+
{
7479+
"name": "id",
7480+
"type": "String",
7481+
"default": "`self.class.generate_id`",
7482+
"description": "The unique ID of the panel."
7483+
},
7484+
{
7485+
"name": "size",
7486+
"type": "Symbol",
7487+
"default": "`:small`",
7488+
"description": "The size of the panel. One of `:auto`, `:large`, `:medium`, `:medium_portrait`, `:small`, or `:xlarge`."
7489+
},
7490+
{
7491+
"name": "select_variant",
7492+
"type": "Symbol",
7493+
"default": "`:single`",
7494+
"description": "One of `:multiple`, `:none`, or `:single`."
7495+
},
7496+
{
7497+
"name": "fetch_strategy",
7498+
"type": "Symbol",
7499+
"default": "`:remote`",
7500+
"description": "One of `:eventually_local`, `:local`, or `:remote`."
7501+
},
7502+
{
7503+
"name": "no_results_label",
7504+
"type": "String",
7505+
"default": "`\"No results found\"`",
7506+
"description": "The label to display when no results are found."
7507+
},
7508+
{
7509+
"name": "preload",
7510+
"type": "Boolean",
7511+
"default": "`false`",
7512+
"description": "Whether to preload search results when the page loads. If this option is false, results are loaded when the panel is opened."
7513+
},
7514+
{
7515+
"name": "dynamic_label",
7516+
"type": "Boolean",
7517+
"default": "`false`",
7518+
"description": "Whether or not to display the text of the currently selected item in the show button."
7519+
},
7520+
{
7521+
"name": "dynamic_label_prefix",
7522+
"type": "String",
7523+
"default": "`nil`",
7524+
"description": "If provided, the prefix is prepended to the dynamic label and displayed in the show button."
7525+
},
7526+
{
7527+
"name": "dynamic_aria_label_prefix",
7528+
"type": "String",
7529+
"default": "`nil`",
7530+
"description": "If provided, the prefix is prepended to the dynamic label and set as the value of the `aria-label` attribute on the show button."
7531+
},
7532+
{
7533+
"name": "body_id",
7534+
"type": "String",
7535+
"default": "`nil`",
7536+
"description": "The unique ID of the panel body. If not provided, the body ID will be set to the panel ID with a \"-body\" suffix."
7537+
},
7538+
{
7539+
"name": "list_arguments",
7540+
"type": "Hash",
7541+
"default": "`{}`",
7542+
"description": "Arguments to pass to the underlying {{#link_to_component}}Primer::Alpha::ActionList{{/link_to_component}} component. Only has an effect for the local fetch strategy."
7543+
},
7544+
{
7545+
"name": "form_arguments",
7546+
"type": "Hash",
7547+
"default": "`{}`",
7548+
"description": "Form arguments. Supported for `local`, and experimentally supported for `remote` and `eventually_local` strategies by enabling the `use_experimental_non_local_form` flag."
7549+
},
74537550
{
74547551
"name": "use_experimental_non_local_form",
74557552
"type": "Boolean",
74567553
"default": "`false`",
7457-
"description": "A feature flag used to slowly roll out moving the input field (generated from form arguments) to the top of the SelectPanel HTML thus allowing remote fetching to have default form values."
7554+
"description": "A feature flag used to slowly roll out moving the input field (generated from form arguments) to the top of the SelectPanel HTML thus allowing remote fetching to have default form values. At this time, support is only available for the :single select variant. See: https://github.com/github/primer/issues/4923."
74587555
},
74597556
{
74607557
"name": "show_filter",

static/previews.json

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1556,6 +1556,19 @@
15561556
]
15571557
}
15581558
},
1559+
{
1560+
"preview_path": "primer/alpha/banner/scheme_upsell",
1561+
"name": "scheme_upsell",
1562+
"snapshot": "true",
1563+
"skip_rules": {
1564+
"wont_fix": [
1565+
"region"
1566+
],
1567+
"will_fix": [
1568+
"color-contrast"
1569+
]
1570+
}
1571+
},
15591572
{
15601573
"preview_path": "primer/alpha/banner/dismissible",
15611574
"name": "dismissible",

0 commit comments

Comments
 (0)