# @dopt/semantic-data-layer-hints

> An interface definition for Dopt's hints component

Latest version **1.0.3** (published 2024-05-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install @dopt/semantic-data-layer-hints
pnpm add @dopt/semantic-data-layer-hints
yarn add @dopt/semantic-data-layer-hints
bun add @dopt/semantic-data-layer-hints
```

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2024-05-08 |
| First published | 2023-10-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 6.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | kseth, alexchantastic, pankaj-avhad-dopt, chasebish, joemckenney |

## Links

- npm: https://www.npmjs.com/package/@dopt/semantic-data-layer-hints
- Repository: https://github.com/dopt/odopt
- Homepage: https://github.com/dopt/odopt/tree/main/components/%40dopt/semantic-data-layer/hints
- Issues: https://github.com/dopt/odopt/issues
- npm.io page: https://npm.io/package/@dopt/semantic-data-layer-hints

## Dependencies (2)

- [@dopt/core-rich-text](https://npm.io/package/@dopt/core-rich-text.md) 2.3.0
- [@dopt/block-api-types](https://npm.io/package/@dopt/block-api-types.md) 1.3.4

## Recent versions

- 1.0.3 (latest) — 2024-05-08
- 1.0.2 — 2024-03-11
- 1.0.1 — 2024-01-31
- 1.0.0 — 2023-10-25

## README

# @dopt/semantic-data-layer-hint

An interface definition for Dopt's [hint and hint item components](https://docs.dopt.com/components/react/hints/).

```ts
export interface Hints {
  id: string;

  items: HintsItem[];

  active: boolean;

  completed: boolean;
  dismissed: boolean;

  complete: () => void;
  dismiss: () => void;

  size: number;

  filter(on: FilterableField): HintsItem[];
  count(where: CountableField): number;
}

export interface HintsItem {
  id: string;

  hints: Hints | undefined;

  index: number | null | undefined;

  title: string | null | undefined;
  body: RichText | null | undefined;

  completeLabel: string | null | undefined;
  dismissAllLabel: string | null | undefined;

  active: boolean;

  completed: boolean;
  dismissed: boolean;

  complete: () => void;
  dismiss: () => void;
}
```

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