# @types/react-sidebar

> TypeScript definitions for react-sidebar

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

## Install

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

## 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 | 3.0.4 |
| Published | 2023-11-07 |
| First published | 2016-12-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 5.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51449 |
| Maintainers | types |

## Links

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

## Dependencies (1)

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

## Recent versions

- 3.0.4 (latest) — 2023-11-07
- 3.0.2 (ts3.7) — 2021-10-07
- 3.0.1 (ts3.6) — 2021-07-08
- 3.0.0 (ts2.8) — 2018-08-10
- 2.3.0 (ts2.6) — 2018-05-05
- 2.2.2 (ts2.3) — 2017-08-17
- 2.2.0 (ts2.1) — 2017-03-30
- 3.0.3 — 2023-10-18
- 2.3.1 — 2018-08-06
- 2.2.3 — 2018-02-12
- 2.2.1 — 2017-06-23
- 2.2.0-next.0 — 2016-12-29

## README

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

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

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-sidebar.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-sidebar/index.d.ts)
````ts
import { Component, ReactNode } from "react";

export interface SidebarProps {
    children?: ReactNode;
    contentClassName?: string | undefined;
    defaultSidebarWidth?: number | undefined;
    docked?: boolean | undefined;
    dragToggleDistance?: number | undefined;
    onSetOpen?(open: boolean): void;
    open?: boolean | undefined;
    overlayClassName?: string | undefined;
    pullRight?: boolean | undefined;
    rootClassName?: string | undefined;
    shadow?: boolean | undefined;
    sidebar?: React.ReactNode | undefined;
    sidebarClassName?: string | undefined;
    styles?: SidebarStyles | undefined;
    transitions?: boolean | undefined;
    touch?: boolean | undefined;
    touchHandleWidth?: number | undefined;
    rootId?: string | undefined;
    sidebarId?: string | undefined;
    contentId?: string | undefined;
    overlayId?: string | undefined;
}

export interface SidebarStyles {
    content?: Partial<CSSStyleDeclaration> | undefined;
    dragHandle?: Partial<CSSStyleDeclaration> | undefined;
    overlay?: Partial<CSSStyleDeclaration> | undefined;
    root?: Partial<CSSStyleDeclaration> | undefined;
    sidebar?: Partial<CSSStyleDeclaration> | undefined;
}

export default class Sidebar extends Component<SidebarProps> {}

````

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

# Credits
These definitions were written by [Jeroen Vervaeke](https://github.com/jeroenvervaeke).

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