Skip to content

docs(cdk/a11y): update Sass docs for new theming API #22468

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
Apr 21, 2021

Conversation

jelbourn
Copy link
Member

This change updates the Sass documentation for cdk/a11y to reflect the
new @use-based API. Additionally, it adds documentation for the
parameters to cdk.high-contrast.

@jelbourn jelbourn added P2 The issue is important to a large percentage of users, with a workaround docs This issue is related to documentation merge safe target: major This PR is targeted for the next major release area: cdk/a11y labels Apr 13, 2021
@jelbourn jelbourn requested a review from devversion as a code owner April 13, 2021 00:59
@google-cla google-cla bot added the cla: yes PR author has agreed to Google's Contributor License Agreement label Apr 13, 2021
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

The `$target` parameter allows you to specify which variation of high contrast mode your style
targets. The accepted values are `active` (default), `black-on-white`, and `white-on-black`. These
values correspond to the supported values for the
[`-ms-high-contrast` media query][ms-high-contrast].
Copy link
Member

Choose a reason for hiding this comment

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

Not sure whether we should mention the media query, because we wrap the selector with a class which behaves slightly differently when used together with Sass' &.

Copy link
Member Author

Choose a reason for hiding this comment

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

I still want to mention it because it explains where the values come from

Copy link
Member

Choose a reason for hiding this comment

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

Sure, I don't feel strongly against it.

Copy link
Contributor

@twerske twerske left a comment

Choose a reason for hiding this comment

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

lgtm!

@jelbourn jelbourn added target: rc This PR is targeted for the next release-candidate action: merge The PR is ready for merge by the caretaker and removed target: major This PR is targeted for the next major release labels Apr 14, 2021
Copy link

@TeriGlover TeriGlover left a comment

Choose a reason for hiding this comment

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

Editing review; I left a couple of minor suggestions.

@TeriGlover
Copy link

TeriGlover commented Apr 19, 2021 via email

This change updates the Sass documentation for cdk/a11y to reflect the
new `@use`-based API. Additionally, it adds documentation for the
parameters to `cdk.high-contrast`.
@wagnermaciel wagnermaciel merged commit 2a9854e into angular:master Apr 21, 2021
wagnermaciel pushed a commit that referenced this pull request Apr 21, 2021
This change updates the Sass documentation for cdk/a11y to reflect the
new `@use`-based API. Additionally, it adds documentation for the
parameters to `cdk.high-contrast`.

(cherry picked from commit 2a9854e)
@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 May 22, 2021
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: cdk/a11y cla: yes PR author has agreed to Google's Contributor License Agreement docs This issue is related to documentation P2 The issue is important to a large percentage of users, with a workaround target: rc This PR is targeted for the next release-candidate
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants