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.

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

ion-segment, ionChange should explain it is not fired when value changed programmatically #3588

Closed
ChrisHSandN opened this issue Apr 10, 2024 · 1 comment · Fixed by ionic-team/ionic-framework#29407
Labels
content Issues related to the contents of the documentation website

Comments

@ChrisHSandN
Copy link

URL

https://ionicframework.com/docs/api/segment#events

Issue Description

Suggest that the following is added to the end of the ionChange description:

ionChange is not fired when the value is changed programmatically.

Would also be useful on:

It is already stated on:

@ChrisHSandN ChrisHSandN added the triage New issues label Apr 10, 2024
@sean-perkins sean-perkins added content Issues related to the contents of the documentation website and removed triage New issues labels Apr 26, 2024
github-merge-queue bot pushed a commit to ionic-team/ionic-framework that referenced this issue Apr 26, 2024
…lue (#29407)

Issue number: resolves
ionic-team/ionic-docs#3588

---------

<!-- 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. -->

The documentation around `ionChange` not being emitted when
programmatically changing the property associated to the "value" is
either inconsistent or missing from certain components.

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

- Adds the documentation to the missing components.
- Makes the documentation consistent across components.

## Does this introduce a breaking change?

- [ ] Yes
- [x] No

<!--
  If this introduces a breaking change:
1. Describe the impact and migration path for existing applications
below.
  2. Update the BREAKING.md file with the breaking change.
3. Add "BREAKING CHANGE: [...]" to the commit description when merging.
See
https://github.com/ionic-team/ionic-framework/blob/main/docs/CONTRIBUTING.md#footer
for more information.
-->


## Other information

<!-- Any other information that is important to this PR such as
screenshots of how the component looks before and after the change. -->
@sean-perkins
Copy link
Contributor

Hello 👋 thanks for this issue!

I've addressed this here: ionic-team/ionic-framework#29407 and it will be available in the docs after the next patch release.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Issues related to the contents of the documentation website
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants