|
325 | 325 | "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_menu.rb", |
326 | 326 | "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_menu/default/", |
327 | 327 | "parameters": [ |
| 328 | + { |
| 329 | + "name": "menu_id", |
| 330 | + "type": "String", |
| 331 | + "default": "`self.class.generate_id`", |
| 332 | + "description": "Id of the menu." |
| 333 | + }, |
| 334 | + { |
| 335 | + "name": "anchor_align", |
| 336 | + "type": "Symbol", |
| 337 | + "default": "`:start`", |
| 338 | + "description": "One of `:center`, `:end`, or `:start`.." |
| 339 | + }, |
| 340 | + { |
| 341 | + "name": "anchor_side", |
| 342 | + "type": "Symbol", |
| 343 | + "default": "`:outside_bottom`", |
| 344 | + "description": "One of `:inside_bottom`, `:inside_center`, `:inside_left`, `:inside_right`, `:inside_top`, `:outside_bottom`, `:outside_left`, `:outside_right`, or `:outside_top`.." |
| 345 | + }, |
| 346 | + { |
| 347 | + "name": "size", |
| 348 | + "type": "Symbol", |
| 349 | + "default": "`:auto`", |
| 350 | + "description": "One of `:auto`, `:large`, `:medium`, `:medium_portrait`, `:small`, or `:xlarge`.." |
| 351 | + }, |
| 352 | + { |
| 353 | + "name": "src", |
| 354 | + "type": "String", |
| 355 | + "default": "`nil`", |
| 356 | + "description": "Used with an `include-fragment` element to load menu content from the given source URL." |
| 357 | + }, |
| 358 | + { |
| 359 | + "name": "preload", |
| 360 | + "type": "Boolean", |
| 361 | + "default": "`false`", |
| 362 | + "description": "When true, and src is present, loads the `include-fragment` on trigger hover." |
| 363 | + }, |
| 364 | + { |
| 365 | + "name": "dynamic_label", |
| 366 | + "type": "Boolean", |
| 367 | + "default": "`false`", |
| 368 | + "description": "Whether or not to display the text of the currently selected item in the show button." |
| 369 | + }, |
| 370 | + { |
| 371 | + "name": "dynamic_label_prefix", |
| 372 | + "type": "String", |
| 373 | + "default": "`nil`", |
| 374 | + "description": "If provided, the prefix is prepended to the dynamic label and displayed in the show button." |
| 375 | + }, |
| 376 | + { |
| 377 | + "name": "select_variant", |
| 378 | + "type": "Symbol", |
| 379 | + "default": "`:none`", |
| 380 | + "description": "One of `:multiple`, `:none`, or `:single`." |
| 381 | + }, |
| 382 | + { |
| 383 | + "name": "form_arguments", |
| 384 | + "type": "Hash", |
| 385 | + "default": "`{}`", |
| 386 | + "description": "Allows an `ActionMenu` to act as a select list in multi- and single-select modes. Pass the `builder:` and `name:` options to this hash. `builder:` should be an instance of `ActionView::Helpers::FormBuilder`, which are created by the standard Rails `#form_with` and `#form_for` helpers. The `name:` option is the desired name of the field that will be included in the params sent to the server on form submission." |
| 387 | + }, |
| 388 | + { |
| 389 | + "name": "overlay_arguments", |
| 390 | + "type": "Hash", |
| 391 | + "default": "`{}`", |
| 392 | + "description": "Arguments to pass to the underlying [Overlay](/components/alpha/overlay)" |
| 393 | + }, |
328 | 394 | { |
329 | 395 | "name": "system_arguments", |
330 | 396 | "type": "Hash", |
331 | 397 | "default": "N/A", |
332 | | - "description": "The arguments accepted by [ActionMenu::PrimaryMenu](/components/alpha/actionmenuprimarymenu)." |
| 398 | + "description": "[System arguments](/system-arguments)." |
333 | 399 | } |
334 | 400 | ] |
335 | 401 | }, |
|
418 | 484 | "name": "system_arguments", |
419 | 485 | "type": "Hash", |
420 | 486 | "default": "N/A", |
421 | | - "description": "The arguments accepted by [ActionMenu::ListWrapper](/components/alpha/actionmenulistwrapper)" |
| 487 | + "description": "The arguments accepted by [ActionList](/components/alpha/actionlist)" |
422 | 488 | } |
423 | 489 | ] |
424 | 490 | }, |
|
444 | 510 | } |
445 | 511 | ] |
446 | 512 | }, |
447 | | - { |
448 | | - "component": "ActionMenu::Menu", |
449 | | - "status": "alpha", |
450 | | - "a11y_reviewed": false, |
451 | | - "short_name": "ActionMenuMenu", |
452 | | - "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_menu/menu.rb", |
453 | | - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_menu/menu/default/", |
454 | | - "parameters": [ |
455 | | - { |
456 | | - "name": "anchor_align", |
457 | | - "type": "Symbol", |
458 | | - "default": "N/A", |
459 | | - "description": "One of `:center`, `:end`, or `:start`." |
460 | | - }, |
461 | | - { |
462 | | - "name": "anchor_side", |
463 | | - "type": "Symbol", |
464 | | - "default": "N/A", |
465 | | - "description": "One of `:inside_bottom`, `:inside_center`, `:inside_left`, `:inside_right`, `:inside_top`, `:outside_bottom`, `:outside_left`, `:outside_right`, or `:outside_top`." |
466 | | - }, |
467 | | - { |
468 | | - "name": "menu_id", |
469 | | - "type": "String", |
470 | | - "default": "`self.class.generate_id`", |
471 | | - "description": "Id of the menu." |
472 | | - }, |
473 | | - { |
474 | | - "name": "size", |
475 | | - "type": "Symbol", |
476 | | - "default": "`:auto`", |
477 | | - "description": "One of `:auto`, `:large`, `:medium`, `:medium_portrait`, `:small`, or `:xlarge`." |
478 | | - }, |
479 | | - { |
480 | | - "name": "src", |
481 | | - "type": "String", |
482 | | - "default": "`nil`", |
483 | | - "description": "Used with an `include-fragment` element to load menu content from the given source URL." |
484 | | - }, |
485 | | - { |
486 | | - "name": "preload", |
487 | | - "type": "Boolean", |
488 | | - "default": "`false`", |
489 | | - "description": "When true, and src is present, loads the `include-fragment` on trigger hover." |
490 | | - }, |
491 | | - { |
492 | | - "name": "select_variant", |
493 | | - "type": "Symbol", |
494 | | - "default": "`:none`", |
495 | | - "description": "One of `:multiple`, `:none`, or `:single`." |
496 | | - }, |
497 | | - { |
498 | | - "name": "form_arguments", |
499 | | - "type": "Hash", |
500 | | - "default": "`{}`", |
501 | | - "description": "Allows an `ActionMenu` to act as a select list in multi- and single-select modes. Pass the `builder:` and `name:` options to this hash. `builder:` should be an instance of `ActionView::Helpers::FormBuilder`, which are created by the standard Rails `#form_with` and `#form_for` helpers. The `name:` option is the desired name of the field that will be included in the params sent to the server on form submission." |
502 | | - }, |
503 | | - { |
504 | | - "name": "overlay_arguments", |
505 | | - "type": "Hash", |
506 | | - "default": "`{}`", |
507 | | - "description": "Arguments to pass to the underlying [Overlay](/components/alpha/overlay)" |
508 | | - }, |
509 | | - { |
510 | | - "name": "list_arguments", |
511 | | - "type": "Hash", |
512 | | - "default": "`{}`", |
513 | | - "description": "Arguments to pass to the underlying [ActionMenu::List](/components/alpha/actionmenulist)" |
514 | | - }, |
515 | | - { |
516 | | - "name": "system_arguments", |
517 | | - "type": "Hash", |
518 | | - "default": "N/A", |
519 | | - "description": "[System arguments](/system-arguments)." |
520 | | - } |
521 | | - ] |
522 | | - }, |
523 | | - { |
524 | | - "component": "ActionMenu::PrimaryMenu", |
525 | | - "status": "alpha", |
526 | | - "a11y_reviewed": false, |
527 | | - "short_name": "ActionMenuPrimaryMenu", |
528 | | - "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_menu/primary_menu.rb", |
529 | | - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_menu/primary_menu/default/", |
530 | | - "parameters": [ |
531 | | - { |
532 | | - "name": "anchor_align", |
533 | | - "type": "Symbol", |
534 | | - "default": "`:start`", |
535 | | - "description": "One of `:center`, `:end`, or `:start`." |
536 | | - }, |
537 | | - { |
538 | | - "name": "anchor_side", |
539 | | - "type": "Symbol", |
540 | | - "default": "`:outside_bottom`", |
541 | | - "description": "One of `:inside_bottom`, `:inside_center`, `:inside_left`, `:inside_right`, `:inside_top`, `:outside_bottom`, `:outside_left`, `:outside_right`, or `:outside_top`." |
542 | | - }, |
543 | | - { |
544 | | - "name": "dynamic_label", |
545 | | - "type": "Boolean", |
546 | | - "default": "`false`", |
547 | | - "description": "Whether or not to display the text of the currently selected item in the show button." |
548 | | - }, |
549 | | - { |
550 | | - "name": "dynamic_label_prefix", |
551 | | - "type": "String", |
552 | | - "default": "`nil`", |
553 | | - "description": "If provided, the prefix is prepended to the dynamic label and displayed in the show button." |
554 | | - }, |
555 | | - { |
556 | | - "name": "system_arguments", |
557 | | - "type": "Hash", |
558 | | - "default": "N/A", |
559 | | - "description": "[System arguments](/system-arguments)." |
560 | | - } |
561 | | - ] |
562 | | - }, |
563 | | - { |
564 | | - "component": "ActionMenu::SubMenu", |
565 | | - "status": "alpha", |
566 | | - "a11y_reviewed": false, |
567 | | - "short_name": "ActionMenuSubMenu", |
568 | | - "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_menu/sub_menu.rb", |
569 | | - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_menu/sub_menu/default/", |
570 | | - "parameters": [ |
571 | | - { |
572 | | - "name": "menu_id", |
573 | | - "type": "String", |
574 | | - "default": "`self.class.generate_id`", |
575 | | - "description": "Id of the menu." |
576 | | - }, |
577 | | - { |
578 | | - "name": "anchor_align", |
579 | | - "type": "Symbol", |
580 | | - "default": "`:start`", |
581 | | - "description": "One of `:center`, `:end`, or `:start`." |
582 | | - }, |
583 | | - { |
584 | | - "name": "anchor_side", |
585 | | - "type": "Symbol", |
586 | | - "default": "`:outside_right`", |
587 | | - "description": "One of `:inside_bottom`, `:inside_center`, `:inside_left`, `:inside_right`, `:inside_top`, `:outside_bottom`, `:outside_left`, `:outside_right`, or `:outside_top`." |
588 | | - }, |
589 | | - { |
590 | | - "name": "overlay_arguments", |
591 | | - "type": "Hash", |
592 | | - "default": "`{}`", |
593 | | - "description": "Arguments to pass to the underlying [Overlay](/components/alpha/overlay)" |
594 | | - }, |
595 | | - { |
596 | | - "name": "system_arguments", |
597 | | - "type": "Hash", |
598 | | - "default": "N/A", |
599 | | - "description": "[System arguments](/system-arguments)." |
600 | | - } |
601 | | - ] |
602 | | - }, |
603 | | - { |
604 | | - "component": "ActionMenu::SubMenuItem", |
605 | | - "status": "alpha", |
606 | | - "a11y_reviewed": false, |
607 | | - "short_name": "ActionMenuSubMenuItem", |
608 | | - "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_menu/sub_menu_item.rb", |
609 | | - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_menu/sub_menu_item/default/", |
610 | | - "parameters": [] |
611 | | - }, |
612 | 513 | { |
613 | 514 | "component": "AutoComplete", |
614 | 515 | "status": "deprecated", |
|
0 commit comments