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

feat(segment): add playground & docs for segment view #3875

Merged
merged 4 commits into from
Nov 4, 2024

Conversation

tanner-reits
Copy link
Member

NOTE: These docs are for an unreleased feature, to test, please update the version used by the playgrounds and component API plugin to the following dev build:
8.3.4-dev.11730395663.1a0f4848

What's Changed:

  • Adds playground to ion-segment docs for new "swipeable segments"
  • Adds doc pages for ion-segment-content and ion-segment-view

Associated feature PR: ionic-team/ionic-framework#29969

Copy link

vercel bot commented Nov 1, 2024

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 Nov 4, 2024 9:38pm

Copy link
Member Author

@tanner-reits tanner-reits left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe deployment is gonna fail since the component API doesn't for ion-segment-view in the current v8 scope.

docs/api/segment-content.md Show resolved Hide resolved
@tanner-reits tanner-reits marked this pull request as ready for review November 1, 2024 14:33
@tanner-reits tanner-reits requested a review from a team as a code owner November 1, 2024 14:33
Copy link
Member

@brandyscarney brandyscarney left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested locally using the dev build with all demos & StackBlitz examples. Note for anyone running this locally you will have to comment out this usage to avoid errors:

---
title: "ion-segment-view"
---

<!-- import Props from '@ionic-internal/component-api/v8/segment-view/props.md';
import Events from '@ionic-internal/component-api/v8/segment-view/events.md'; -->

<!-- ## Properties

<Props />

## Events

<Events /> -->

Looks good! 👍

Copy link
Contributor

@thetaPC thetaPC left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding the events and props to the segment content and the grammar are my major requests. The rest are suggestions.

docs/api/segment-content.md Outdated Show resolved Hide resolved
docs/api/segment-view.md Show resolved Hide resolved
docs/api/segment.md Show resolved Hide resolved
Copy link
Contributor

@thetaPC thetaPC left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@tanner-reits tanner-reits merged commit f61213d into feature-8.4 Nov 4, 2024
4 checks passed
@tanner-reits tanner-reits deleted the tr/ROU-11249-segment-view-playground branch November 4, 2024 22:10
tanner-reits added a commit that referenced this pull request Nov 4, 2024
* feat(segment): add playground & docs for segment view

* fix(segment-view): api import version

* fix(segment-content): usage & common API sections

* Force CI run
tanner-reits added a commit that referenced this pull request Nov 4, 2024
* docs(select): add `modal` interface to `ion-select` docs (#3872)

* docs(select): update select docs for modal interface

* fix(select): point playground to correct demo

* feat(segment): add playground & docs for segment view (#3875)

* feat(segment): add playground & docs for segment view

* fix(segment-view): api import version

* fix(segment-content): usage & common API sections

* Force CI run
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.

3 participants