javascript/ionic-framework
1
0
Fork 0
mirror of https://github.com/ionic-team/ionic-framework.git synced 2025-08-19 19:57:22 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(modal, popover): improve showBackdrop clarity (#25462)

Browse Source
This commit is contained in:
Liam DeBeasi
2022-06-14 09:49:42 -04:00
committed by GitHub
parent 377c4f597b
commit 35c1adf10c
3 changed files with 12 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
core/src/components.d.ts vendored
View File

@ -1600,7 +1600,7 @@ export namespace Components {
*/
"setCurrentBreakpoint": (breakpoint: number) => Promise<void>;
/**
* If `true`, a backdrop will be displayed behind the modal.
* If `true`, a backdrop will be displayed behind the modal. This property controls whether or not the backdrop darkens the screen when the modal is presented. It does not control whether or not the backdrop is active or present in the DOM.
*/
"showBackdrop": boolean;
/**
@ -1966,7 +1966,7 @@ export namespace Components {
*/
"reference": PositionReference;
/**
* If `true`, a backdrop will be displayed behind the popover.
* If `true`, a backdrop will be displayed behind the popover. This property controls whether or not the backdrop darkens the screen when the popover is presented. It does not control whether or not the backdrop is active or present in the DOM.
*/
"showBackdrop": boolean;
/**
@ -5528,7 +5528,7 @@ declare namespace LocalJSX {
*/
"presentingElement"?: HTMLElement;
/**
* If `true`, a backdrop will be displayed behind the modal.
* If `true`, a backdrop will be displayed behind the modal. This property controls whether or not the backdrop darkens the screen when the modal is presented. It does not control whether or not the backdrop is active or present in the DOM.
*/
"showBackdrop"?: boolean;
/**
@ -5816,7 +5816,7 @@ declare namespace LocalJSX {
*/
"reference"?: PositionReference;
/**
* If `true`, a backdrop will be displayed behind the popover.
* If `true`, a backdrop will be displayed behind the popover. This property controls whether or not the backdrop darkens the screen when the popover is presented. It does not control whether or not the backdrop is active or present in the DOM.
*/
"showBackdrop"?: boolean;
/**

4
core/src/components/modal/modal.tsx
View File

@ -166,6 +166,10 @@ export class Modal implements ComponentInterface, OverlayInterface {
/**
* If `true`, a backdrop will be displayed behind the modal.
* This property controls whether or not the backdrop
* darkens the screen when the modal is presented.
* It does not control whether or not the backdrop
* is active or present in the DOM.
*/
@Prop() showBackdrop = true;

4
core/src/components/popover/popover.tsx
View File

@ -128,6 +128,10 @@ export class Popover implements ComponentInterface, PopoverInterface {
/**
* If `true`, a backdrop will be displayed behind the popover.
* This property controls whether or not the backdrop
* darkens the screen when the popover is presented.
* It does not control whether or not the backdrop
* is active or present in the DOM.
*/
@Prop() showBackdrop = true;