Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor(panelmenu): replace submenuIcon with expandIcon and collapse… #7031

Merged
merged 3 commits into from
Aug 21, 2024
Merged

refactor(panelmenu): replace submenuIcon with expandIcon and collapse… #7031

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
eeec220
refactor(panelmenu): replace submenuIcon with expandIcon and collapse…
franmc01 Aug 12, 2024
fac3628
Updated the api doc
nitrogenous Aug 21, 2024
d262cbd
Merge branch 'master' into master
nitrogenous Aug 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 25 additions & 10 deletions components/doc/common/apidoc/index.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40995,6 +40995,14 @@
"default": "",
"description": "Used to get the child elements of the component."
},
{
"name": "collapseIcon",
"optional": true,
"readonly": false,
"type": "IconType<PanelMenuProps>",
"default": "",
"description": "Icon used when a submenu is expanded."
},
{
"name": "expandedKeys",
"optional": true,
Expand All @@ -41003,6 +41011,14 @@
"default": "",
"description": "A map of keys to represent the expansion state in controlled mode."
},
{
"name": "expandIcon",
"optional": true,
"readonly": false,
"type": "IconType<PanelMenuProps>",
"default": "",
"description": "Icon used when a submenu is collapsed."
},
{
"name": "model",
"optional": true,
Expand Down Expand Up @@ -41035,14 +41051,6 @@
"default": "",
"description": "Used to configure passthrough(pt) options of the component."
},
{
"name": "submenuIcon",
"optional": true,
"readonly": false,
"type": "IconType<PanelMenuProps>",
"default": "",
"description": "Icon of the submenu."
},
{
"name": "transitionOptions",
"optional": true,
Expand Down Expand Up @@ -41175,11 +41183,18 @@
"description": "Uses to pass attributes to the header content's DOM element."
},
{
"name": "submenuIcon",
"name": "expandIcon",
"optional": true,
"readonly": false,
"type": "PanelMenuPassThroughType<HTMLAttributes<HTMLSpanElement> | SVGProps<SVGSVGElement>>",
"description": "Uses to pass attributes to the expand icon's DOM element."
},
{
"name": "collapseIcon",
"optional": true,
"readonly": false,
"type": "PanelMenuPassThroughType<HTMLAttributes<HTMLSpanElement> | SVGProps<SVGSVGElement>>",
"description": "Uses to pass attributes to the submenuIcon's DOM element."
"description": "Uses to pass attributes to the collapse icon's DOM element."
},
{
"name": "headerIcon",
Expand Down
11 changes: 10 additions & 1 deletion components/lib/panelmenu/PanelMenu.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -272,22 +272,31 @@ export const PanelMenu = React.memo(

const key = item.id || idState + '_' + index;
const active = isItemActive(item);

const iconClassName = classNames('p-menuitem-icon', item.icon);
const headerIconProps = mergeProps(
{
className: cx('headerIcon', { item })
},
getPTOptions(item, 'headerIcon', index)
);

const icon = IconUtils.getJSXIcon(item.icon, { ...headerIconProps }, { props });

const submenuIconClassName = 'p-panelmenu-icon';
const headerSubmenuIconProps = mergeProps(
{
className: cx('headerSubmenuIcon')
},
getPTOptions(item, 'headerSubmenuIcon', index)
);
const submenuIcon = item.items && IconUtils.getJSXIcon(active ? props.submenuIcon || <ChevronDownIcon {...headerSubmenuIconProps} /> : props.submenuIcon || <ChevronRightIcon {...headerSubmenuIconProps} />);

const submenuIcon = item.items && IconUtils.getJSXIcon(
active
? (props.collapseIcon || <ChevronDownIcon {...headerSubmenuIconProps} />)
: (props.expandIcon || <ChevronRightIcon {...headerSubmenuIconProps} />)
);

const headerLabelProps = mergeProps(
{
className: cx('headerLabel')
Expand Down
3 changes: 2 additions & 1 deletion components/lib/panelmenu/PanelMenuBase.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,14 +75,15 @@ export const PanelMenuBase = ComponentBase.extend({
id: null,
model: null,
style: null,
submenuIcon: null,
expandedKeys: null,
className: null,
onExpandedKeysChange: null,
onOpen: null,
onClose: null,
multiple: false,
transitionOptions: null,
expandIcon: null,
collapseIcon: null,
children: undefined
},
css: {
Expand Down
3 changes: 2 additions & 1 deletion components/lib/panelmenu/PanelMenuList.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -429,7 +429,8 @@ export const PanelMenuList = React.memo((props) => {
onItemToggle={onItemToggle}
level={0}
className={cx('submenu')}
submenuIcon={props.submenuIcon}
expandIcon={props.expandIcon}
collapseIcon={props.collapseIcon}
root
ptm={ptm}
cx={cx}
Expand Down
11 changes: 9 additions & 2 deletions components/lib/panelmenu/PanelMenuSub.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,8 @@ export const PanelMenuSub = React.memo(
onItemToggle={onItemToggle}
menuProps={props.menuProps}
model={processedItem.items}
submenuIcon={props.submenuIcon}
expandIcon={props.expandIcon}
collapseIcon={props.collapseIcon}
ptm={ptm}
cx={cx}
/>
Expand Down Expand Up @@ -183,7 +184,13 @@ export const PanelMenuSub = React.memo(
},
getPTOptions(processedItem, 'submenuicon', index)
);
const submenuIcon = item.items && IconUtils.getJSXIcon(active ? props.submenuIcon || <ChevronDownIcon {...submenuIconProps} /> : props.submenuIcon || <ChevronRightIcon {...submenuIconProps} />);

const submenuIcon = item.items && IconUtils.getJSXIcon(
active
? (props.collapseIcon || <ChevronDownIcon {...submenuIconProps} />)
: (props.expandIcon || <ChevronRightIcon {...submenuIconProps} />)
);

const submenu = createSubmenu(processedItem, active);
const actionProps = mergeProps(
{
Expand Down
16 changes: 12 additions & 4 deletions components/lib/panelmenu/panelmenu.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,13 @@ export interface PanelMenuPassThroughOptions {
*/
headerContent?: PanelMenuPassThroughType<React.HTMLAttributes<HTMLDivElement>>;
/**
* Uses to pass attributes to the submenuIcon's DOM element.
* Uses to pass attributes to the expand icon's DOM element.
*/
submenuIcon?: PanelMenuPassThroughType<React.SVGProps<SVGSVGElement> | React.HTMLAttributes<HTMLSpanElement>>;
expandIcon?: PanelMenuPassThroughType<React.SVGProps<SVGSVGElement> | React.HTMLAttributes<HTMLSpanElement>>;
/**
* Uses to pass attributes to the collapse icon's DOM element.
*/
collapseIcon?: PanelMenuPassThroughType<React.SVGProps<SVGSVGElement> | React.HTMLAttributes<HTMLSpanElement>>;
/**
* Uses to pass attributes to the header icon's DOM element.
*/
Expand Down Expand Up @@ -179,9 +183,13 @@ export interface PanelMenuProps extends Omit<React.DetailedHTMLProps<React.HTMLA
*/
multiple?: boolean | undefined;
/**
* Icon of the submenu.
* Icon used when a submenu is collapsed.
*/
expandIcon?: IconType<PanelMenuProps> | undefined;
/**
* Icon used when a submenu is expanded.
*/
submenuIcon?: IconType<PanelMenuProps> | undefined;
collapseIcon?: IconType<PanelMenuProps> | undefined;
/**
* The properties of CSSTransition can be customized, except for "nodeRef" and "in" properties.
*/
Expand Down
Loading