# presentation-widget

> The Augmented.js Next - Presentation Application Module.

Latest version **3.0.0** (published 2020-07-19) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install presentation-widget
pnpm add presentation-widget
yarn add presentation-widget
bun add presentation-widget
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.0 |
| Published | 2020-07-19 |
| First published | 2018-08-10 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 37.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Bob Warren |
| Maintainers | thedocbwarren |
| Keywords | augmentedjs, presentation |

## Links

- npm: https://www.npmjs.com/package/presentation-widget
- Repository: https://github.com/Augmentedjs/presentation-widget
- Homepage: http://www.augmentedjs.com
- Issues: https://github.com/Augmentedjs/presentation-widget/issues
- npm.io page: https://npm.io/package/presentation-widget

## Recent versions

- 3.0.0 (latest) — 2020-07-19
- 2.5.6 — 2019-05-21
- 2.5.5 — 2018-11-12
- 2.5.4 — 2018-08-21
- 2.5.3 — 2018-08-10
- 2.5.2 — 2018-08-10

## README

# presentation-widget

Augmented.js Presentation Widget Module

# API

<!-- Generated by documentation.js. Update this documentation by updating the source code. -->

### Table of Contents

-   [Widget](#widget)
    -   [List](#list)
        -   [Parameters](#parameters)
    -   [DescriptionList](#descriptionlist)
        -   [Parameters](#parameters-1)
    -   [DataList](#datalist)
        -   [Parameters](#parameters-2)
    -   [Input](#input)
        -   [Parameters](#parameters-3)
        -   [Examples](#examples)

## Widget

Widgets and small presentation modules

### List

List widget - renders a standard list

#### Parameters

-   `id` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The id of the parent to attach the list
-   `data` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)** The data to render
-   `ordered` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** True if the list should be ordered
-   `binding` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The binding (used for decorator and optional)

Returns **[Element](https://developer.mozilla.org/docs/Web/API/Element)** Returns a DOM element as a list

### DescriptionList

DescriptionList widget - renders a description list

#### Parameters

-   `id` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The id of the parent to attach the list
-   `data` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** The data to render
-   `binding` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The binding (used for decorator and optional)

Returns **[Element](https://developer.mozilla.org/docs/Web/API/Element)** Returns a DOM element as a description list

### DataList

DataList widget - renders a data list

#### Parameters

-   `id` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The id of the parent to attach the list
-   `data` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)** The data to render
-   `binding` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The binding (used for decorator and optional)

Returns **[Element](https://developer.mozilla.org/docs/Web/API/Element)** Returns a DOM element as a data list

### Input

Input widget - renders an input or simular based on type

#### Parameters

-   `field` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Field property object (required)
-   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The name of the field
-   `value` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The value to preset
-   `id` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The id of the field
-   `required` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** If the field is required
-   `binding` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The binding (used for decorator and optional)

#### Examples

```javascript
field object format:
{
  "description": "Something",
  "type": "string", // string, number, integer, boolean, object (can be an array), email, uri, date-time
  "minimum": 0,
  "maximum": 85,
  "format": "email", // optional
  "pattern": "[A-Za-z]", // any regex
  "value": "bubba",
  "enum": [ "something", ... ]
}
```

Returns **[Element](https://developer.mozilla.org/docs/Web/API/Element)** Returns a DOM element as an input

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