Skip to content

Commit

Permalink
Refactor #4391 - for MegaMenu
Browse files Browse the repository at this point in the history
  • Loading branch information
@habubey
habubey committed May 18, 2023
1 parent dc9e37c commit ea8c8b1
Show file tree
Hide file tree
Showing 7 changed files with 1,021 additions and 48 deletions.
242 changes: 242 additions & 0 deletions components/doc/common/apidoc/index.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22648,6 +22648,14 @@
"type": "ReactNode",
"default": "",
"description": "Used to get the child elements of the component."
},
{
"name": "pt",
"optional": true,
"readonly": false,
"type": "MegaMenuPassThroughOptions",
"default": "",
"description": "Uses to pass attributes to DOM elements inside the component."
}
]
},
Expand All @@ -22656,6 +22664,240 @@
"values": []
}
}
},
"interfaces": {
"description": "Defines the custom interfaces used by the module.",
"values": {
"MegaMenuPassThroughMethodOptions": {
"description": "Custom passthrough(pt) option method.",
"relatedProp": "",
"props": [
{
"name": "props",
"optional": false,
"readonly": false,
"type": "MegaMenuProps"
},
{
"name": "state",
"optional": false,
"readonly": false,
"type": "MegaMenuState"
},
{
"name": "context",
"optional": false,
"readonly": false,
"type": "MegaMenuContext"
}
],
"callbacks": []
},
"MegaMenuPassThroughOptions": {
"description": "Custom passthrough(pt) options.",
"relatedProp": "pt",
"props": [
{
"name": "root",
"optional": true,
"readonly": false,
"type": "MegaMenuPassThroughType<HTMLAttributes<HTMLDivElement>>",
"description": "Uses to pass attributes to the root's DOM element."
},
{
"name": "menu",
"optional": true,
"readonly": false,
"type": "MegaMenuPassThroughType<HTMLAttributes<HTMLUListElement>>",
"description": "Uses to pass attributes to the list's DOM element."
},
{
"name": "menuitem",
"optional": true,
"readonly": false,
"type": "MegaMenuPassThroughType<HTMLAttributes<HTMLLIElement>>",
"description": "Uses to pass attributes to the list item's DOM element."
},
{
"name": "headerAction",
"optional": true,
"readonly": false,
"type": "MegaMenuPassThroughType<HTMLAttributes<HTMLAnchorElement>>",
"description": "Uses to pass attributes to the header action's DOM element."
},
{
"name": "action",
"optional": true,
"readonly": false,
"type": "MegaMenuPassThroughType<HTMLAttributes<HTMLAnchorElement>>",
"description": "Uses to pass attributes to the action's DOM element."
},
{
"name": "icon",
"optional": true,
"readonly": false,
"type": "MegaMenuPassThroughType<HTMLAttributes<HTMLSpanElement> | SVGProps<SVGSVGElement>>",
"description": "Uses to pass attributes to the icon's DOM element."
},
{
"name": "label",
"optional": true,
"readonly": false,
"type": "MegaMenuPassThroughType<HTMLAttributes<HTMLSpanElement>>",
"description": "Uses to pass attributes to the label's DOM element."
},
{
"name": "submenuIcon",
"optional": true,
"readonly": false,
"type": "MegaMenuPassThroughType<HTMLAttributes<HTMLSpanElement> | SVGProps<SVGSVGElement>>",
"description": "Uses to pass attributes to the submenu icon's DOM element."
},
{
"name": "panel",
"optional": true,
"readonly": false,
"type": "MegaMenuPassThroughType<HTMLAttributes<HTMLDivElement>>",
"description": "Uses to pass attributes to the panel's DOM element."
},
{
"name": "grid",
"optional": true,
"readonly": false,
"type": "MegaMenuPassThroughType<HTMLAttributes<HTMLDivElement>>",
"description": "Uses to pass attributes to the grid's DOM element."
},
{
"name": "column",
"optional": true,
"readonly": false,
"type": "MegaMenuPassThroughType<HTMLAttributes<HTMLDivElement>>",
"description": "Uses to pass attributes to the column's DOM element."
},
{
"name": "submenu",
"optional": true,
"readonly": false,
"type": "MegaMenuPassThroughType<HTMLAttributes<HTMLUListElement>>",
"description": "Uses to pass attributes to the submenu's DOM element."
},
{
"name": "submenuItem",
"optional": true,
"readonly": false,
"type": "MegaMenuPassThroughType<HTMLAttributes<HTMLLIElement>>",
"description": "Uses to pass attributes to the submenu items's DOM element."
},
{
"name": "submenuHeader",
"optional": true,
"readonly": false,
"type": "MegaMenuPassThroughType<HTMLAttributes<HTMLLIElement>>",
"description": "Uses to pass attributes to the submenu header's DOM element."
},
{
"name": "separator",
"optional": true,
"readonly": false,
"type": "MegaMenuPassThroughType<HTMLAttributes<HTMLDivElement>>",
"description": "Uses to pass attributes to the separator's DOM element."
},
{
"name": "start",
"optional": true,
"readonly": false,
"type": "MegaMenuPassThroughType<HTMLAttributes<HTMLDivElement>>",
"description": "Uses to pass attributes to the start of the component."
},
{
"name": "end",
"optional": true,
"readonly": false,
"type": "MegaMenuPassThroughType<HTMLAttributes<HTMLDivElement>>",
"description": "Uses to pass attributes to the end of the component."
}
],
"callbacks": []
},
"MegaMenuFocusedItemInfo": {
"description": "Defines focused item info",
"relatedProp": "",
"props": [
{
"name": "index",
"optional": false,
"readonly": false,
"type": "number",
"description": "Active item index"
},
{
"name": "level",
"optional": false,
"readonly": false,
"type": "number",
"description": "Active item level"
},
{
"name": "parentKey",
"optional": false,
"readonly": false,
"type": "string",
"description": "Parent key info"
}
],
"callbacks": []
},
"MegaMenuState": {
"description": "Defines current inline state in MegaMenu component.",
"relatedProp": "",
"props": [
{
"name": "mobileActive",
"optional": false,
"readonly": false,
"type": "boolean",
"description": "Current mobileActive state as a boolean."
},
{
"name": "attributeSelector",
"optional": false,
"readonly": false,
"type": "boolean",
"description": "Current attributeSelector visible state as a string."
},
{
"name": "activeItem",
"optional": false,
"readonly": false,
"type": "MenuItem",
"description": "Active item path."
}
],
"callbacks": []
},
"MegaMenuContext": {
"description": "Defines current options in MegaMenu 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": {
"MegaMenuPassThroughType": {
"values": "PassThroughType<T, MegaMenuPassThroughMethodOptions>"
}
}
}
},
"mention": {
Expand Down
Loading

0 comments on commit ea8c8b1

Please sign in to comment.