@krasnoff/react-accessibility-component 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/README.md +53 -0
- package/dist/components/react-accessibility-component/components/accessibility-logo.d.ts +8 -0
- package/dist/components/react-accessibility-component/components/accessibility-logo.d.ts.map +1 -0
- package/dist/components/react-accessibility-component/components/menu-item.d.ts +8 -0
- package/dist/components/react-accessibility-component/components/menu-item.d.ts.map +1 -0
- package/dist/components/react-accessibility-component/enums/font-size-direction.enum.d.ts +6 -0
- package/dist/components/react-accessibility-component/enums/font-size-direction.enum.d.ts.map +1 -0
- package/dist/components/react-accessibility-component/hooks/use-accessibility-compoenent.d.ts +6 -0
- package/dist/components/react-accessibility-component/hooks/use-accessibility-compoenent.d.ts.map +1 -0
- package/dist/components/react-accessibility-component/react-accessibility-component.d.ts +4 -0
- package/dist/components/react-accessibility-component/react-accessibility-component.d.ts.map +1 -0
- package/dist/components/react-accessibility-component/types/font-size.type.d.ts +3 -0
- package/dist/components/react-accessibility-component/types/font-size.type.d.ts.map +1 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +27799 -0
- package/package.json +1 -1
package/dist/README.md
ADDED
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
# React Vite Accessibility Component
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
`AccessibilityComponent` is a React component designed to enhance web accessibility by providing essential features that support users with disabilities. It is intended to be used as part of a broader strategy for making web applications accessible.
|
|
6
|
+
|
|
7
|
+
## Installation
|
|
8
|
+
|
|
9
|
+
To install the component, use npm or yarn:
|
|
10
|
+
|
|
11
|
+
```
|
|
12
|
+
npm install react-accessibility-component
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
or
|
|
16
|
+
|
|
17
|
+
```
|
|
18
|
+
yarn add react-accessibility-component
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Usage
|
|
22
|
+
|
|
23
|
+
Import and use the component in your React application:
|
|
24
|
+
|
|
25
|
+
```
|
|
26
|
+
import { AccessibilityComponent } from 'react-accessibility-component'
|
|
27
|
+
|
|
28
|
+
function App() {
|
|
29
|
+
return (
|
|
30
|
+
<AccessibilityComponent>
|
|
31
|
+
<h1>Vite + React to NPM repository</h1>
|
|
32
|
+
</AccessibilityComponent>
|
|
33
|
+
)
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
export default App
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
Now add the following css file to the `index.html` file in your project:
|
|
40
|
+
|
|
41
|
+
```
|
|
42
|
+
<link rel="stylesheet" href="node_modules/react-accessibility-component/dist/react-accessibility-component.css" />
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
## Important Notice
|
|
46
|
+
|
|
47
|
+
Using `AccessibilityComponent` alone does not guarantee full accessibility compliance. It is the responsibility of developers to build their web applications following the WCAG accessibility standards. This includes proper semantic HTML, keyboard navigability, sufficient color contrast, and providing alternative text for images, among other requirements.
|
|
48
|
+
|
|
49
|
+
For comprehensive guidance on making your website accessible, refer to the official [WCAG](https://www.w3.org/WAI/standards-guidelines/wcag/) guidelines.
|
|
50
|
+
|
|
51
|
+
## License
|
|
52
|
+
|
|
53
|
+
This component is open-source and available under the MIT License.
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
interface AccessibilityLogoProps {
|
|
2
|
+
width: string;
|
|
3
|
+
height: string;
|
|
4
|
+
fill: string;
|
|
5
|
+
}
|
|
6
|
+
declare const AccessibilityLogo: (props: AccessibilityLogoProps) => import("react/jsx-runtime").JSX.Element;
|
|
7
|
+
export default AccessibilityLogo;
|
|
8
|
+
//# sourceMappingURL=accessibility-logo.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"accessibility-logo.d.ts","sourceRoot":"","sources":["../../../../src/components/react-accessibility-component/components/accessibility-logo.tsx"],"names":[],"mappings":"AAgBA,UAAU,sBAAsB;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,QAAA,MAAM,iBAAiB,GAAI,OAAO,sBAAsB,4CAsNvD,CAAA;AAED,eAAe,iBAAiB,CAAC"}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
export interface MenuItemProps {
|
|
2
|
+
title: string;
|
|
3
|
+
ImageSvgComponent: React.FunctionComponent<React.SVGProps<SVGSVGElement>>;
|
|
4
|
+
fill: string;
|
|
5
|
+
}
|
|
6
|
+
declare const MenuItem: React.FC<MenuItemProps>;
|
|
7
|
+
export default MenuItem;
|
|
8
|
+
//# sourceMappingURL=menu-item.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"menu-item.d.ts","sourceRoot":"","sources":["../../../../src/components/react-accessibility-component/components/menu-item.tsx"],"names":[],"mappings":"AAAA,MAAM,WAAW,aAAa;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,iBAAiB,EAAE,KAAK,CAAC,iBAAiB,CAAC,KAAK,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAC;IAC1E,IAAI,EAAE,MAAM,CAAA;CACf;AAED,QAAA,MAAM,QAAQ,EAAE,KAAK,CAAC,EAAE,CAAC,aAAa,CAOrC,CAAC;AAEF,eAAe,QAAQ,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"font-size-direction.enum.d.ts","sourceRoot":"","sources":["../../../../src/components/react-accessibility-component/enums/font-size-direction.enum.ts"],"names":[],"mappings":"AAAA,oBAAY,iBAAiB;IACzB,QAAQ,KAAK;IACb,IAAI,IAAI;IACR,QAAQ,IAAI;CACf"}
|
package/dist/components/react-accessibility-component/hooks/use-accessibility-compoenent.d.ts.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"use-accessibility-compoenent.d.ts","sourceRoot":"","sources":["../../../../src/components/react-accessibility-component/hooks/use-accessibility-compoenent.ts"],"names":[],"mappings":"AAGA,iBAAS,yBAAyB;;;EAoJjC;AAED,eAAe,yBAAyB,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"react-accessibility-component.d.ts","sourceRoot":"","sources":["../../../src/components/react-accessibility-component/react-accessibility-component.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAM1B,QAAA,MAAM,sBAAsB,EAAE,KAAK,CAAC,EAkBnC,CAAC;AAEF,OAAO,EAAE,sBAAsB,EAAE,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"font-size.type.d.ts","sourceRoot":"","sources":["../../../../src/components/react-accessibility-component/types/font-size.type.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,QAAQ,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC,CAAC;AACnF,eAAO,MAAM,WAAW,UAAsD,CAAC"}
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":""}
|