Skip to content

Commit df779de

Browse files
Updated accessibility plugin documentation.
1 parent b589fc8 commit df779de

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

docs/plugins/accessibility.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Accessibility
22

3-
The Accessibility plugin provides functionality to easily make your App more accesible.
3+
The Accessibility plugin provides functionality to easily make your App more accessible.
44

55
Currently it provides functionality to apply a **Colorshifting filter** to your App, helping people with different types of color blindness to properly use your App.
66

@@ -52,7 +52,7 @@ The `normal` type color filter should be used for cases where you only want to a
5252

5353
### Advanced use
5454

55-
The typical use of the colorshift filter is to apply it over the entire app (using `this.appliction.coloshift()`). But there may also be cases where you want to apply it only to a single element (for demo purposes or during in-app configuration of the color settings, for example).
55+
The typical use of the colorshift filter is to apply it over the entire app (using `this.appliction.colorshift()`). But there may also be cases where you want to apply it only to a single element (for demo purposes or during in-app configuration of the color settings, for example).
5656

5757
In this case you should import the `Accessibility` plugin into your component.
5858

@@ -73,8 +73,13 @@ Accessibility.colorshift(element, type, config)
7373

7474
Important to remember is that the element you apply the colorshift filter to shouldn't already have a _shader_ applied to it, nor can it have `rtt` set to `true`. In these cases you could create a wrapper and apply the colorshift filter to the wrapper instead.
7575

76+
<!--
77+
Todo
78+
7679
### Colorshift configuration UX
7780
7881
To make it as easy as possible to make your App colorblindness friendly, we have made available a standard importable [UI component](...) to set and configure the colorshift settings for your App.
7982
8083
Feel free to use this UI component directly inside your App. Or use it as inspiration to build your own configuration screen.
84+
85+
-->

0 commit comments

Comments
 (0)