# @types/react-albus

> TypeScript definitions for react-albus

Latest version **2.0.12** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/react-albus
pnpm add @types/react-albus
yarn add @types/react-albus
bun add @types/react-albus
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 2.0.12 |
| Published | 2023-11-07 |
| First published | 2018-07-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 6.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51442 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/react-albus
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-albus
- npm.io page: https://npm.io/package/@types/react-albus

## Dependencies (2)

- [@types/react](https://npm.io/package/@types/react.md) *
- [@types/history](https://npm.io/package/@types/history.md) ^4.7.11

## Recent versions

- 2.0.12 (latest) — 2023-11-07
- 2.0.9 (ts4.1) — 2022-11-04
- 2.0.8 (ts3.8) — 2022-01-18
- 2.0.7 (ts3.7) — 2021-10-27
- 2.0.6 (ts3.6) — 2021-07-08
- 2.0.5 (ts2.8) — 2019-04-18
- 2.0.0 (ts2.6) — 2018-07-16
- 2.0.11 — 2023-10-18
- 2.0.10 — 2023-09-27
- 2.0.4 — 2018-12-06
- 2.0.3 — 2018-09-27
- 2.0.2 — 2018-09-21
- 2.0.1 — 2018-08-04

## README

# Installation
> `npm install --save @types/react-albus`

# Summary
This package contains type definitions for react-albus (https://github.com/americanexpress/react-albus#readme).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-albus.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-albus/index.d.ts)
````ts
import { History } from "history";
import * as React from "react";

export interface StepObject {
    id: string;
}

export interface WizardContext {
    step: StepObject;
    steps: StepObject[];
    history: History;
    next: () => void;
    previous: () => void;
    go: (n: number) => void;
    push: (id?: string) => void;
    replace: (id?: string) => void;
}

export interface WizardComponentProps {
    wizard: WizardContext;
}

export function withWizard<P>(
    component: React.ComponentType<P & WizardComponentProps>,
): React.ComponentType<P>;

export type WizardProps = {
    onNext?: ((wizard: WizardContext) => void) | undefined;
    history?: History | undefined;
    basename?: string | undefined;
} & WizardContextRenderProps;

export const Wizard: React.ComponentType<WizardProps>;

export type WizardContextRenderProps =
    | { render?: ((wizard: WizardContext) => React.ReactNode) | undefined }
    | { children: ((wizard: WizardContext) => React.ReactNode) | React.ReactNode };

export const WithWizard: React.ComponentType<WizardContextRenderProps>;

export interface StepsProps {
    children: NonNullable<React.ReactNode>;
    step?: StepObject | undefined;
}

export const Steps: React.ComponentType<StepsProps>;

export type StepProps = StepObject & WizardContextRenderProps;

/**
 * In addition to id, any additional props added to <Step> will be available on each step object.
 * This can be used to add names, descriptions, or other metadata to each step.
 * To use this feature globally in your project you need to augment the StepObject
 * @example
 * declare module "react-albus" {
 *   interface StepObject {
 *     propName: string;
 *   }
 * }
 */
export const Step: React.ComponentType<StepProps>;

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 09:09:39 GMT
 * Dependencies: [@types/history](https://npmjs.com/package/@types/history), [@types/react](https://npmjs.com/package/@types/react)

# Credits
These definitions were written by [Sindre Seppola](https://github.com/sseppola), [Conrad Reuter](https://github.com/conradreuter), and [Jonas Kugelmann](https://github.com/kuirak).

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