docs(popover): clarify size property (#27894)

Issue number: N/A

---------

<!-- Please do not submit updates to dependencies unless it fixes an
issue. -->

<!-- Please try to limit your pull request to one type (bugfix, feature,
etc). Submit multiple pull requests if needed. -->

## What is the current behavior?
<!-- Please describe the current behavior that you are modifying. -->

See: https://github.com/ionic-team/ionic-framework/issues/27877

The current description does not accurately describe what `size="auto"`
does.

## What is the new behavior?
<!-- Please describe the behavior or changes that are being added by
this PR. -->

- Description clarifies that the width of the popover is set based on
platform defaults.

## Does this introduce a breaking change?

- [ ] Yes
- [x] No

<!-- If this introduces a breaking change, please describe the impact
and migration path for existing applications below. -->


## Other information

<!-- Any other information that is important to this PR such as
screenshots of how the component looks before and after the change. -->
This commit is contained in:
Liam DeBeasi
2023-07-31 11:25:45 -04:00
committed by GitHub
parent ba2f49b8a4
commit b8553d89f8
2 changed files with 3 additions and 4 deletions

View File

@ -2176,7 +2176,7 @@ export namespace Components {
*/ */
"side": PositionSide; "side": PositionSide;
/** /**
* Describes how to calculate the popover width. If `"cover"`, the popover width will match the width of the trigger. If `"auto"`, the popover width will be determined by the content in the popover. * Describes how to calculate the popover width. If `"cover"`, the popover width will match the width of the trigger. If `"auto"`, the popover width will be set to a static default value.
*/ */
"size": PopoverSize; "size": PopoverSize;
/** /**
@ -6189,7 +6189,7 @@ declare namespace LocalJSX {
*/ */
"side"?: PositionSide; "side"?: PositionSide;
/** /**
* Describes how to calculate the popover width. If `"cover"`, the popover width will match the width of the trigger. If `"auto"`, the popover width will be determined by the content in the popover. * Describes how to calculate the popover width. If `"cover"`, the popover width will match the width of the trigger. If `"auto"`, the popover width will be set to a static default value.
*/ */
"size"?: PopoverSize; "size"?: PopoverSize;
/** /**

View File

@ -180,8 +180,7 @@ export class Popover implements ComponentInterface, PopoverInterface {
/** /**
* Describes how to calculate the popover width. * Describes how to calculate the popover width.
* If `"cover"`, the popover width will match the width of the trigger. * If `"cover"`, the popover width will match the width of the trigger.
* If `"auto"`, the popover width will be determined by the content in * If `"auto"`, the popover width will be set to a static default value.
* the popover.
*/ */
@Prop() size: PopoverSize = 'auto'; @Prop() size: PopoverSize = 'auto';