# @mandala-ui/list

> Mandala UI List Component

Latest version **1.0.8** (published 2018-04-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install @mandala-ui/list
pnpm add @mandala-ui/list
yarn add @mandala-ui/list
bun add @mandala-ui/list
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.8 |
| Published | 2018-04-09 |
| First published | 2018-03-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 187.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Lucas K Allmon |
| Maintainers | lucaska |
| Keywords | react, css, library, components, interface, functional, OOCSS, declarative, ui, user, ux |

## Links

- npm: https://www.npmjs.com/package/@mandala-ui/list
- npm.io page: https://npm.io/package/@mandala-ui/list

## Alternatives

- [style-dictionary](https://npm.io/package/style-dictionary.md) — 2.0M weekly downloads
- [postcss-merge-idents](https://npm.io/package/postcss-merge-idents.md) — 1.7M weekly downloads
- [@fontsource/noto-sans](https://npm.io/package/@fontsource/noto-sans.md) — 93.0K weekly downloads
- [uglifycss](https://npm.io/package/uglifycss.md) — 71.6K weekly downloads
- [mat4-interpolate](https://npm.io/package/mat4-interpolate.md) — 23.3K weekly downloads

## Recent versions

- 1.0.8 (latest) — 2018-04-09
- 1.0.7 — 2018-04-06
- 1.0.6 — 2018-03-31
- 1.0.5 — 2018-03-29
- 1.0.4 — 2018-03-29
- 1.0.2 — 2018-03-28
- 1.0.1 — 2018-03-12

## README

## Mandala UI List Component
Mandala is a React component library that utilizes a declarative CSS library for styling.

### Installation
Check the [MonoRepo README](https://github.com/mandala-ui/mandala) for installation.

### Description
A List is used for content in order or in sequence. The props on this list allow you to create robust compound components. It renders all the children inside a `<ListItem />` component.

### Usage
if using the whole library:
```js
import { List } from 'mandala';
```
if only using this component:
```js
import List from '@mandala-ui/list';
```
### Props
* `children` - items that will be in the list, they must be elements
* `contained` - will remove the last bottom border if the list is contained inside another element
* `indented` - adds padding for a contained list
* `lineColor` - the color of the bottom border of each ListItem
* `lined` - set this prop to add lines
* `lineWidth` - width of lines, clamped 1-5.
* `narrow` - little padding between ListItems.
* `ordered` - add a number to the front of each ListItem
* `wide` - lots of padding between ListItems

| propName | propType | defaultValue | isRequired |
| -------- | -------- | ------------ | ---------- |
| children | node     | null         | -          |
| contained| boolean  | false        | -          |
| indented | boolean  | false        | -          |
| lineColor| string   | 'white'      | -          |
| lined    | boolean  | false        | -          |
| lineWidth| number   | 0            | -          |
| narrow   | boolean  | false        | -          |
| ordered  | boolean  | false        | -          |
| wide     | boolean  | false        | -          |

#### TODO:
- [ ] background colors
- [ ] striped
- [ ] infer `lined` from lineColor prop existence

![mandala-bottom](https://user-images.githubusercontent.com/1824267/38281372-32114e5c-375f-11e8-9fbe-e5191b96429c.png)

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