Skip to content

Commit

Permalink
chore: bump version to 0.5.0
Browse files Browse the repository at this point in the history
  • Loading branch information
bpetermann committed Nov 7, 2024
1 parent 686caf2 commit c00b9ef
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 1 deletion.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),

## [Unreleased]

## [0.5.0] - 2024-11-07

### Changed

- Enhanced accessibility check for generic text in the `<A>` component to include applicable ARIA roles.
Expand Down Expand Up @@ -84,3 +86,4 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
[0.2.2]: https://github.com/bpetermann/aware-components/releases/tag/v.0.2.2
[0.3.2]: https://github.com/bpetermann/aware-components/releases/tag/v0.3.2
[0.4.2]: https://github.com/bpetermann/aware-components/releases/tag/v0.4.2
[0.5.0]: https://github.com/bpetermann/aware-components/releases/tag/v0.4.2
12 changes: 12 additions & 0 deletions packages/aware-components/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ The goal is to improve accessibility by ensuring proper usage of naming conventi
- **Built-in Accessibility Checks**: Each component provides real-time accessibility feedback, including warnings about heading levels, contrast issues, ARIA labels, and more.
- **Common HTML Elements**: Components are based on familiar HTML elements, making them easy to integrate into existing projects.
- **Customizable Warnings**: Developers receive accessibility warnings during development, enabling quick fixes and improvements.
- **Standalone Accessibility Checks**: In addition to components, several standalone accessibility checks are exported for broader use.
- **Expandable**: While currently focused on accessibility, the library is designed to expand in the future.

## Stability Warning ⚠️
Expand Down Expand Up @@ -91,6 +92,17 @@ function Headings() {
}
```

**Example 3: Standalone Accessibility checks**

In addition to the components, some standalone accessibility checks are exported.

```jsx
import { isRatioOk, canHaveAriaHidden } from 'aware-components';

console.log(isRatioOk('white', 'black', 'AAA', 18)); // Checks if the contrast ratio between text and background colors meets WCAG level AA or AAA, based on text size.
console.log(canHaveAriaHidden(SomeComponent())); // Checks if the aria-hidden attribute can be applied to the component.
```

## Mix and Match

Most components can be used alongside standard HTML elements. This flexibility allows for easy integration, but for the most comprehensive accessibility insights, consider using `aware-components` for all core elements in your component tree.
Expand Down
2 changes: 1 addition & 1 deletion packages/aware-components/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "aware-components",
"private": false,
"version": "0.4.2",
"version": "0.5.0",
"description": "React components with built-in accessibility checks for common HTML elements.",
"type": "module",
"main": "dist/index.umd.js",
Expand Down

0 comments on commit c00b9ef

Please sign in to comment.