Skip to content

Add documentation for forced-colors-adjust #1675

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.

Sign up for GitHub

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

Closed
lukewarlow wants to merge 1 commit into from
Closed

Add documentation for forced-colors-adjust #1675

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/navs/documentation.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@ export const documentationNav = {
pages['will-change'],
],
SVG: [pages['fill'], pages['stroke'], pages['stroke-width']],
Accessibility: [pages['screen-readers']],
Accessibility: [pages['screen-readers'], pages['forced-colors-adjust']],
'Official Plugins': [
pages['typography-plugin'],
{
Expand Down
20 changes: 20 additions & 0 deletions src/pages/docs/forced-colors-adjust.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: "Forced Colors Adjust"
description: "Utilities for controlling whether forced-colors mode applies to an element."
---

import utilities from 'utilities?plugin=forcedColorsAdjust'

export const classes = { utilities }

## Basic usage

### Opt-out of forced colors

Use `forced-colors-none` to opt an element out of `forced-colors` adjustment:

```html
<div class="forced-colors-none">
<!-- Content that needs to opt out of forced-colors mode -->
</div>
```