Skip to content

Commit

Permalink
fixing prettier
Browse files Browse the repository at this point in the history
  • Loading branch information
@shameerrehman
shameerrehman committed Aug 30, 2023
1 parent 50657f1 commit 76ff85d
Showing 1 changed file with 13 additions and 12 deletions.
25 changes: 13 additions & 12 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,21 +25,21 @@ started this project [here](blue.verto.health/advancing-accessibility-with-astra
- Line Height
- More to come!

| Key | Capability |
| ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ```Screen Reader``` | Screen reader is a tool where it would reads out texts on screen where user clicks on. For any html elements, if an aria label is available, the content from aria label would be read out loud, otherwise, it reads the text content of the element. There are 3 different speeds, normal, fast and slow. |
| ```Contrast``` | Contrast is a tool that removes background and replaces it with black or white to increase the difference in colours between text and the background to increase legibility. There are 3 modes, the invert colours, high contrast, and dark high contrast. |
| ```Saturation``` | Saturation is a tool that adjusts how colourful the colours are on screen, it has 3 different modes to lower saturation, increase saturation, or remove all the colours on screen (black and white). |
| ```Bigger Text``` | Bigger Text is a tool that increases the size of the texts on screen. |
| ```Text Spacing``` | Text Spacing is a tool that increases the spacing between each character on the screen to increase legibility and readibility. |
| ```Screen Mask``` | Screen Mask is a tool which dims the background and has a smaller focused area which follows the cursor sliding up and down the page. |
| ```Line Spacing``` | Line Spacing is a tool which increases the space between lines for greater readability. |
| Key | Capability |
| --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Screen Reader` | Screen reader is a tool where it would reads out texts on screen where user clicks on. For any html elements, if an aria label is available, the content from aria label would be read out loud, otherwise, it reads the text content of the element. There are 3 different speeds, normal, fast and slow. |
| `Contrast` | Contrast is a tool that removes background and replaces it with black or white to increase the difference in colours between text and the background to increase legibility. There are 3 modes, the invert colours, high contrast, and dark high contrast. |
| `Saturation` | Saturation is a tool that adjusts how colourful the colours are on screen, it has 3 different modes to lower saturation, increase saturation, or remove all the colours on screen (black and white). |
| `Bigger Text` | Bigger Text is a tool that increases the size of the texts on screen. |
| `Text Spacing` | Text Spacing is a tool that increases the spacing between each character on the screen to increase legibility and readibility. |
| `Screen Mask` | Screen Mask is a tool which dims the background and has a smaller focused area which follows the cursor sliding up and down the page. |
| `Line Spacing` | Line Spacing is a tool which increases the space between lines for greater readability. |

## Usage

Astral is built with Angular Elements. You can use it in your website in under 30 seconds. To add it, simply include the Javascript and initialize it:

Note: By default this function all will add all available features, for enabling only certain features, see the section below on Customizing Widget.
Note: By default this function all will add all available features, for enabling only certain features, see the section below on Customizing Widget.

```html
<script src="https://astral-accessibility.pages.dev/main.js"></script>
Expand All @@ -48,9 +48,10 @@ Note: By default this function all will add all available features, for enabling
</script>
```

## Customizing Widget
## Customizing Widget

Astral-Accessibility allows you to customize the widget to your needs. This mean you can enable the features you want and hide the features you may not need.
You can choose which widgets should appear by passing an object inside of the ```inititalizeAstral``` function call. Inside the object include a key called ```enabledFeatures``` with the value of a list containing strings of which features you want enabled.
You can choose which widgets should appear by passing an object inside of the `inititalizeAstral` function call. Inside the object include a key called `enabledFeatures` with the value of a list containing strings of which features you want enabled.

Here's an example:

Expand Down

0 comments on commit 76ff85d

Please sign in to comment.