Skip to content

docs(material/chips): migrate examples to MDC #25661

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

Merged
merged 1 commit into from
Sep 28, 2022

Conversation

zarend
Copy link
Contributor

@zarend zarend commented Sep 19, 2022

Migrate chips examples to use mdc-based components.

@zarend zarend added docs This issue is related to documentation target: major This PR is targeted for the next major release area: material/chips labels Sep 19, 2022
@zarend zarend requested a review from crisbeto September 19, 2022 17:43
@angular-robot angular-robot bot added the area: docs Related to the documentation label Sep 19, 2022
Copy link
Contributor

@mmalerba mmalerba left a comment

Choose a reason for hiding this comment

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

The markdown overview for chips definitely needs to be updated since the API has changed significantly. Are you planning to do that in a followup PR?

@zarend
Copy link
Contributor Author

zarend commented Sep 19, 2022

Are you talking about https://github.com/angular/components/blob/main/src/material/chips/chips.md ?

@zarend
Copy link
Contributor Author

zarend commented Sep 19, 2022

I forgot about that, but I can take care of the documentation in this PR. I'll change this PR to a draft and re-request reviews when it's ready.

@zarend zarend marked this pull request as draft September 19, 2022 23:01
@zarend zarend added the dev-app preview When applied, previews of the dev-app are deployed to Firebase label Sep 20, 2022
@github-actions
Copy link

github-actions bot commented Sep 20, 2022

@zarend
Copy link
Contributor Author

zarend commented Sep 21, 2022

I'm working on fleshing out the chips.md rn. I can re-request reviews when it's ready.

@zarend
Copy link
Contributor Author

zarend commented Sep 22, 2022

Added a rough draft of the chips.md documentation.

@zarend zarend marked this pull request as ready for review September 22, 2022 19:27
@zarend
Copy link
Contributor Author

zarend commented Sep 22, 2022

@crisbeto @mmalerba I've added the documentation overview for chips, and this is ready for your eyes 👀

@zarend zarend force-pushed the chips-mdc-examples branch 2 times, most recently from 0b84490 to a74eff7 Compare September 22, 2022 19:30
@zarend zarend requested a review from mmalerba September 22, 2022 19:30

#### Adding Icons

A chip has two spots to display icons using content projection.
Copy link
Member

Choose a reason for hiding this comment

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

Might be worth mentioning here that the icons are optional.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I re-wrote part about icons. LMK what you think

@zarend
Copy link
Contributor Author

zarend commented Sep 23, 2022

ty for reviewing, I'll revise the chips.md documentation then re-request a review

@devversion devversion removed their request for review September 24, 2022 16:13
@zarend zarend force-pushed the chips-mdc-examples branch 3 times, most recently from 9574313 to 310b9f4 Compare September 27, 2022 15:58
@zarend
Copy link
Contributor Author

zarend commented Sep 27, 2022

@mmalerba @crisbeto I updated the overview documentation (chips.md), and this is ready for your eyes 👀

@zarend zarend requested a review from crisbeto September 27, 2022 16:00
Copy link
Member

@crisbeto crisbeto left a comment

Choose a reason for hiding this comment

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

LGTM

<mat-chip-option disabled>Orange</mat-chip-option>
```

#### Keyboard Interactions
Copy link
Member

Choose a reason for hiding this comment

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

nit: not sure if we the keyboard interactions section shouldn't be part of the "Accessibility" section. Not a blocker though.

Migrate chips examples to use mdc-based components. Add documentation
overview for mdc-based chips component.
@zarend zarend added merge safe action: merge The PR is ready for merge by the caretaker and removed dev-app preview When applied, previews of the dev-app are deployed to Firebase labels Sep 28, 2022
@zarend zarend merged commit 4429ce1 into angular:main Sep 28, 2022
@angular-automatic-lock-bot
Copy link

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Oct 29, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
action: merge The PR is ready for merge by the caretaker area: docs Related to the documentation area: material/chips docs This issue is related to documentation target: major This PR is targeted for the next major release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants