Skip to content

docs(config): add code snippets of how to access the mode per framework #4147

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

joesphchang
Copy link

Added ionic-mode to the appropriate section in Config

Initial issue: Issue #2580

@joesphchang joesphchang requested a review from a team as a code owner June 11, 2025 17:56
Copy link

vercel bot commented Jun 11, 2025

@joesphchang is attempting to deploy a commit to the Ionic Team on Vercel.

A member of the Team first needs to authorize it.

Copy link

vercel bot commented Jun 12, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
ionic-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 12, 2025 2:50pm

@joesphchang joesphchang reopened this Jun 12, 2025
@brandyscarney
Copy link
Member

Thank you for this!

I spoke with the team, and we think it would be clearer if getting the mode were its own section, separate from the get method. This helps make it more obvious that the get method isn't available in all frameworks.

For example, Angular would remain the same:

old

And a new section would be added, either before or after the Angular one:

new

Additionally, we should make sure that all framework examples are consistent. This would be a good use case for adding a playground if we want to apply styles based on the mode. You can see an example of a playground in a guide page here: https://ionicframework.com/docs/utilities/gestures#basic-gestures

And the source code for that example is here: https://github.com/ionic-team/ionic-docs/tree/main/static/usage/v8/gestures/basic

Lastly, we need to make sure this documentation is also added to the v7 directories:

Let me know if you have any questions!

@brandyscarney brandyscarney changed the title docs(config): added given code-snippets to config file docs(config): add code snippets of how to access the mode per framework Jun 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants