# @amnis/layout

Latest version **0.1.0-alpha.4** (published 2022-05-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install @amnis/layout
pnpm add @amnis/layout
yarn add @amnis/layout
bun add @amnis/layout
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0-alpha.4 |
| Published | 2022-05-16 |
| First published | 2022-04-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 119.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Eric Crowell |
| Maintainers | eric-crowell |

## Links

- npm: https://www.npmjs.com/package/@amnis/layout
- Repository: https://github.com/amnis-dev/amnis-design
- npm.io page: https://npm.io/package/@amnis/layout

## Dependencies (1)

- [@amnis/style](https://npm.io/package/@amnis/style.md) 0.1.0-alpha.4

## Recent versions

- 0.1.0-alpha.4 (latest) — 2022-05-16
- 0.1.0-alpha.3 — 2022-04-24
- 0.1.0-alpha.2 — 2022-04-24
- 0.1.0-alpha.1 — 2022-04-24

## README

<div align="center">

<img width="150" hight="150" src="static/amnis-logo-256.png" alt="Amnis logo" />

</div>

<h1 align="center">Amnis Design</h1>

<p align="center">
  A react-based design system with an emphasis on clarity, accessibility, and user experience.
</p>

<div align="center">

[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/amnis-dev/amnis-design/blob/main/LICENSE)
[![npm latest package](https://img.shields.io/npm/v/@amnis/design/latest.svg)](https://www.npmjs.com/package/@amnis/design)
[![npm downloads](https://img.shields.io/npm/dm/@amnis/design.svg)](https://www.npmjs.com/package/@amnis/design)

Workflows

[![Storybook](https://github.com/amnis-dev/amnis-design/actions/workflows/storybook.yml/badge.svg)](https://github.com/amnis-dev/amnis-design/actions/workflows/storybook.yml)
[![Integrity Check](https://github.com/amnis-dev/amnis-design/actions/workflows/integrity-check.yml/badge.svg)](https://github.com/amnis-dev/amnis-design/actions/workflows/integrity-check.yml)
[![Package](https://github.com/amnis-dev/amnis-design/actions/workflows/package.yml/badge.svg)](https://github.com/amnis-dev/amnis-design/actions/workflows/package.yml)

</div>

## Example

|       | URL    |
| :---: | :----- |
| ![Sorybook Logo](static/storybook-logo.png) | [Storybook webpage of Design Componets](https://storybook.amnis.dev) |

## Motivation

There's a lot to consider when designing a web application, and even more with accessibility and user experience in mind.

Complying to accessibility standards is complex, redundant, and sometimes confusing for common interfaces. Much like having to manage your memory in some low-level languages, it can be extraordinarily difficult to master proper implementation and catch issues when they inevitably arise.

This design system focuses on delivering modern methods that abstract and bundle accessibility and user experience implementations (provided by the [WCAG 2 Guidelines](https://www.w3.org/WAI/WCAG21/quickref/)) for desktop and mobile environments: easing the efforts to a better web for all internet users.

This library is inspired by qualities from both the [U.S. Web Design System](https://github.com/uswds/uswds) and [MUI Core](https://github.com/mui/material-ui).

This library also aims help with legal compliance of many [governmental policies](https://www.w3.org/WAI/policies/) for the public and private sectors. You should always provide your own testing to ensure you meet your specific requirements.

# Alpha Stage

This library currently in the alpha stages of development. There are still features to create and refine; however, you can still download and use the package to provide feedback by [writing GitHub issues](https://github.com/amnis-dev/amnis-design/issues/new).

## Installation

Amnis Design is available as an [npm package](https://www.npmjs.com/package/@amnis/design).

```sh
# NPM
npm install @amnis/design

# Yarn
npm add @amnis/design
```

You can optionally install individual parts of the design system. Useful if you only desire specific features.

```sh
# NPM
npm install @amnis/hooks @amnis/style @amnis/icons @amnis/layout @amnis/display @amnis/entry

# Yarn
npm add @amnis/hooks @amnis/style @amnis/icons @amnis/layout @amnis/display @amnis/entry
```

## Getting Started with Amnis

Below is a basic example of rendering a `Button` component:

```jsx
import * as React from 'react';
import ReactDOM from 'react-dom';
import { Button } from '@amnis/design/Button';

const App = () => {
  return (
    <Button paint="primary" variant="contained">
      Hello Amnis
    </Button>
  );
}

ReactDOM.createRoot(document.querySelector('#app')).render(<App />);
```

Check it out in an interactive sandbox:

[![Edit Button](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/amnis-design-basic-button-08tb3x)

## Contributing

This is a growing project that you can add and improve upon! I'm welcoming to new PRs. Contrubuting is not just code eiter. If you identify an improvement/bug, [write a new GitHub issue](https://github.com/amnis-dev/amnis-design/issues/new) so I'm made aware and can resolve it.

For code contributions, see the **[contributing documentation](CONTRIBUTING.md)**.

---
_Source: https://npm.io/package/@amnis/layout · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
