Skip to content

Commit

Permalink
Refactor #4391 - for PanelMenu
Browse files Browse the repository at this point in the history
  • Loading branch information
@habubey
habubey committed May 18, 2023
1 parent 52ce700 commit 8ec99d5
Show file tree
Hide file tree
Showing 8 changed files with 987 additions and 42 deletions.
214 changes: 214 additions & 0 deletions components/doc/common/apidoc/index.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27551,6 +27551,14 @@
"type": "ReactNode",
"default": "",
"description": "Used to get the child elements of the component."
},
{
"name": "pt",
"optional": true,
"readonly": false,
"type": "PanelMenuPassThroughOptions",
"default": "",
"description": "Uses to pass attributes to DOM elements inside the component."
}
]
},
Expand All @@ -27559,6 +27567,212 @@
"values": []
}
}
},
"interfaces": {
"description": "Defines the custom interfaces used by the module.",
"values": {
"PanelMenuPassThroughMethodOptions": {
"description": "Custom passthrough(pt) option method.",
"relatedProp": "",
"props": [
{
"name": "props",
"optional": false,
"readonly": false,
"type": "PanelMenuProps"
},
{
"name": "state",
"optional": false,
"readonly": false,
"type": "PanelMenuState"
},
{
"name": "context",
"optional": false,
"readonly": false,
"type": "PanelMenuContext"
}
],
"callbacks": []
},
"PanelMenuPassThroughOptions": {
"description": "Custom passthrough(pt) options.",
"relatedProp": "pt",
"props": [
{
"name": "root",
"optional": true,
"readonly": false,
"type": "PanelMenuPassThroughType<HTMLAttributes<HTMLDivElement>>",
"description": "Uses to pass attributes to the root's DOM element."
},
{
"name": "panel",
"optional": true,
"readonly": false,
"type": "PanelMenuPassThroughType<HTMLAttributes<HTMLDivElement>>",
"description": "Uses to pass attributes to the panel's DOM element."
},
{
"name": "header",
"optional": true,
"readonly": false,
"type": "PanelMenuPassThroughType<HTMLAttributes<HTMLDivElement>>",
"description": "Uses to pass attributes to the header's DOM element."
},
{
"name": "headerAction",
"optional": true,
"readonly": false,
"type": "PanelMenuPassThroughType<HTMLAttributes<HTMLAnchorElement>>",
"description": "Uses to pass attributes to the header action's DOM element."
},
{
"name": "submenuIcon",
"optional": true,
"readonly": false,
"type": "PanelMenuPassThroughType<HTMLAttributes<HTMLSpanElement> | SVGProps<SVGSVGElement>>",
"description": "Uses to pass attributes to the submenuIcon's DOM element."
},
{
"name": "headerIcon",
"optional": true,
"readonly": false,
"type": "PanelMenuPassThroughType<HTMLAttributes<HTMLSpanElement> | SVGProps<SVGSVGElement>>",
"description": "Uses to pass attributes to the header icon's DOM element."
},
{
"name": "headerSubmenuIcon",
"optional": true,
"readonly": false,
"type": "PanelMenuPassThroughType<HTMLAttributes<HTMLSpanElement> | SVGProps<SVGSVGElement>>",
"description": "Uses to pass attributes to the header submenu icon's DOM element."
},
{
"name": "headerLabel",
"optional": true,
"readonly": false,
"type": "PanelMenuPassThroughType<HTMLAttributes<HTMLSpanElement>>",
"description": "Uses to pass attributes to the header label's DOM element."
},
{
"name": "toggleableContent",
"optional": true,
"readonly": false,
"type": "PanelMenuPassThroughType<HTMLAttributes<HTMLDivElement>>",
"description": "Uses to pass attributes to the toggleable content's DOM element."
},
{
"name": "headerToggleableContent",
"optional": true,
"readonly": false,
"type": "PanelMenuPassThroughType<HTMLAttributes<HTMLDivElement>>",
"description": "Uses to pass attributes to the header toggleable content's DOM element."
},
{
"name": "menuContent",
"optional": true,
"readonly": false,
"type": "PanelMenuPassThroughType<HTMLAttributes<HTMLDivElement>>",
"description": "Uses to pass attributes to the menu content's DOM element."
},
{
"name": "menu",
"optional": true,
"readonly": false,
"type": "PanelMenuPassThroughType<HTMLAttributes<HTMLDivElement>>",
"description": "Uses to pass attributes to the list's DOM element."
},
{
"name": "menuitem",
"optional": true,
"readonly": false,
"type": "PanelMenuPassThroughType<HTMLAttributes<HTMLDivElement>>",
"description": "Uses to pass attributes to the list item's DOM element."
},
{
"name": "action",
"optional": true,
"readonly": false,
"type": "PanelMenuPassThroughType<HTMLAttributes<HTMLAnchorElement>>",
"description": "Uses to pass attributes to the action's DOM element."
},
{
"name": "icon",
"optional": true,
"readonly": false,
"type": "PanelMenuPassThroughType<HTMLAttributes<HTMLSpanElement> | SVGProps<SVGSVGElement>>",
"description": "Uses to pass attributes to the icon's DOM element."
},
{
"name": "label",
"optional": true,
"readonly": false,
"type": "PanelMenuPassThroughType<HTMLAttributes<HTMLDivElement>>",
"description": "Uses to pass attributes to the label's DOM element."
},
{
"name": "separator",
"optional": true,
"readonly": false,
"type": "PanelMenuPassThroughType<HTMLAttributes<HTMLLIElement>>",
"description": "Uses to pass attributes to the separator's DOM element."
}
],
"callbacks": []
},
"PanelMenuState": {
"description": "Defines current inline state in PanelMenu component.",
"relatedProp": "",
"props": [
{
"name": "id",
"optional": false,
"readonly": false,
"type": "string",
"description": "Current id state as a string."
},
{
"name": "activeItem",
"optional": false,
"readonly": false,
"type": "MenuItem[]",
"description": "Active item path."
},
{
"name": "animationDisabled",
"optional": false,
"readonly": false,
"type": "boolean",
"description": "Whether the menu is visible or not."
}
],
"callbacks": []
},
"PanelMenuContext": {
"description": "Defines current options in PanelMenu component.",
"relatedProp": "",
"props": [
{
"name": "active",
"optional": false,
"readonly": false,
"type": "boolean",
"description": "Current active state of menuitem as a boolean."
}
],
"callbacks": []
}
}
},
"types": {
"description": "Defines the custom types used by the module.",
"values": {
"PanelMenuPassThroughType": {
"values": "PassThroughType<T, PanelMenuPassThroughMethodOptions>"
}
}
}
},
"password": {
Expand Down
Loading

0 comments on commit 8ec99d5

Please sign in to comment.