Skip to content

fix(drawer): correct modal prop JSDoc typo #8583

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

Open
Razzaghnoori wants to merge 1 commit into
base: master
Choose a base branch
from
+8 −8
Open

fix(drawer): correct modal prop JSDoc typo #8583

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion apps/showcase/doc/common/apidoc/index.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28267,7 +28267,7 @@
"readonly": false,
"type": "boolean",
"default": "true",
"description": "Whether to a modal layer behind the drawer."
"description": "Whether to display a modal layer behind the drawer."
},
{
"name": "blockScroll",
Expand Down
2 changes: 1 addition & 1 deletion apps/showcase/server/assets/llms/components.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12475,7 +12475,7 @@
"name": "modal",
"type": "boolean",
"default": "true",
"description": "Whether to a modal layer behind the drawer."
"description": "Whether to display a modal layer behind the drawer."
},
{
"name": "blockScroll",
Expand Down
2 changes: 1 addition & 1 deletion apps/showcase/server/assets/llms/components/drawer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -636,7 +636,7 @@ const visible = ref(false);
| showCloseIcon | boolean | true | Whether to display a close icon inside the panel. |
| closeButtonProps | object | - | Used to pass the custom value to read for the button inside the component. |
| closeIcon | string | - | Icon to display in the drawer close button. |
| modal | boolean | true | Whether to a modal layer behind the drawer. |
| modal | boolean | true | Whether to display a modal layer behind the drawer. |
| blockScroll | boolean | false | Whether background scroll should be blocked when drawer is visible. |
| dt | any | - | It generates scoped CSS variables using design tokens for the component. |
| pt | PassThrough<DrawerPassThroughOptions> | - | Used to pass attributes to DOM elements inside the component. |
Expand Down
2 changes: 1 addition & 1 deletion apps/showcase/server/assets/llms/llms-full.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17317,7 +17317,7 @@ const visible = ref(false);
| showCloseIcon | boolean | true | Whether to display a close icon inside the panel. |
| closeButtonProps | object | - | Used to pass the custom value to read for the button inside the component. |
| closeIcon | string | - | Icon to display in the drawer close button. |
| modal | boolean | true | Whether to a modal layer behind the drawer. |
| modal | boolean | true | Whether to display a modal layer behind the drawer. |
| blockScroll | boolean | false | Whether background scroll should be blocked when drawer is visible. |
| dt | any | - | It generates scoped CSS variables using design tokens for the component. |
| pt | PassThrough<DrawerPassThroughOptions> | - | Used to pass attributes to DOM elements inside the component. |
Expand Down
2 changes: 1 addition & 1 deletion packages/mcp/data/components.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12475,7 +12475,7 @@
"name": "modal",
"type": "boolean",
"default": "true",
"description": "Whether to a modal layer behind the drawer."
"description": "Whether to display a modal layer behind the drawer."
},
{
"name": "blockScroll",
Expand Down
2 changes: 1 addition & 1 deletion packages/primevue/scripts/components/drawer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ const DrawerProps = [
name: 'modal',
type: 'boolean',
default: 'true',
description: 'Whether to a modal layer behind the sidebar.'
description: 'Whether to display a modal layer behind the drawer.'
},
{
name: 'ariaCloseLabel',
Expand Down
2 changes: 1 addition & 1 deletion packages/primevue/scripts/components/sidebar.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ const SidebarProps = [
name: 'modal',
type: 'boolean',
default: 'true',
description: 'Whether to a modal layer behind the sidebar.'
description: 'Whether to display a modal layer behind the sidebar.'
},
{
name: 'ariaCloseLabel',
Expand Down
2 changes: 1 addition & 1 deletion packages/primevue/src/drawer/Drawer.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ export interface DrawerProps {
*/
closeIcon?: string | undefined;
/**
* Whether to a modal layer behind the drawer.
* Whether to display a modal layer behind the drawer.
* @defaultValue true
*/
modal?: boolean | undefined;
Expand Down