An open API service indexing awesome lists of open source software.

https://github.com/susickypavel/solid-apg

UI toolkit of accessible low-level Solid.js primitives
https://github.com/susickypavel/solid-apg

apg solidjs waiaria

Last synced: 2 months ago
JSON representation

UI toolkit of accessible low-level Solid.js primitives

Awesome Lists containing this project

README

        


Solid APG



Collection of functions (referred to as primitives or builders) developed for the Solid.js library.
It encompasses the logic for crafting accessible UI components while adhering to the WAI-ARIA standard and APG design patterns.

## 1. Installation

```sh
npm install solid-apg@latest
```

```sh
yarn add solid-apg@latest
```

```sh
pnpm install solid-apg@latest
```

```sh
bun add solid-apg@latest
```

## 2. Project structure

| Name | Description | Link | Source code |
| --------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------- | -------------------------------------------------------- |
| `solid-apg` | Package distributed via npm | [npmjs](https://www.npmjs.com/package/solid-apg) | [./packages/solid-apg](./packages/solid-apg) |
| Documentation | Docs page of the `solid-apg` library | [Vercel](https://solid-apg-docs.vercel.app) | [./apps/docs](./apps/docs) |
| Application | Example `SolidStart` application to showcase `solid-apg`. | [Vercel](https://solid-apg-app.vercel.app) | [./apps/solid-start-example](./apps/solid-start-example) |
| Test report | Generated test results for `solid-apg` unit tests | [**GitHub** Pages](https://susickypavel.github.io/solid-apg/report) | - |
| Code coverage | Generated code coverage for `solid-apg` unit tests | [**GitHub** Pages](https://susickypavel.github.io/solid-apg/coverage) | - |
| Typedoc documentation | Generated `typedoc` documentation for `solid-apg` source code | [**GitHub** Pages](https://susickypavel.github.io/solid-apg/typedoc) | - |

## 3. Contributing

### 3.1 Prerequisites

- [Node.js >=18](https://nodejs.org)
- [pnpm >=8](https://pnpm.io)

### 3.2 Installation

```sh
git clone [email protected]:susickypavel/solid-apg.git
cd solid-apg

pnpm install
```