# @types/markdown-navbar

> TypeScript definitions for markdown-navbar

Latest version **1.4.4** (published 2023-12-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/markdown-navbar
pnpm add @types/markdown-navbar
yarn add @types/markdown-navbar
bun add @types/markdown-navbar
```

## 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 | 1.4.4 |
| Published | 2023-12-04 |
| First published | 2021-09-07 |
| 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 | 51442 |
| Maintainers | types |

## Links

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

## Dependencies (1)

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

## Recent versions

- 1.4.4 (latest) — 2023-12-04
- 1.4.3 (ts4.5) — 2023-11-07
- 1.4.0 (ts3.7) — 2021-09-07
- 1.4.2 — 2023-10-18
- 1.4.1 — 2023-09-27

## README

# Installation
> `npm install --save @types/markdown-navbar`

# Summary
This package contains type definitions for markdown-navbar (https://github.com/parksben/markdown-navbar).

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

declare namespace MarkdownNavbar {
    interface MarkdownNavbarProps {
        /** The className that defines the outermost container of navbar */
        className?: string;
        /** Markdown text content */
        source: string;
        /** Anchor displacement relative to the top of the window (for the anchor jump) */
        headingTopOffset?: number;
        /** Automatically update the hash value of browser address when page scrolling if true */
        updateHashAuto?: boolean;
        /** Use the text of the title from Markdown content as the hash value for the anchor if true */
        declarative?: boolean;
        /** Whether the title contains a numerical prefix, such as: 1. 2. 2.2 */
        ordered?: boolean;
        /** The event callback function after clicking navbar item */
        onNavItemClick?: (event: MouseEvent<HTMLDivElement>, element: HTMLDivElement, hashValue: string) => void;
        /** The event callback function before the hash value of browser address changing */
        onHashChange?: (newHash: string, oldHash: string) => void;
    }
}

declare function MarkdownNavbar(options: MarkdownNavbar.MarkdownNavbarProps): JSX.Element;

export = MarkdownNavbar;

````

### Additional Details
 * Last updated: Mon, 04 Dec 2023 17:35:44 GMT
 * Dependencies: [@types/react](https://npmjs.com/package/@types/react)

# Credits
These definitions were written by [Luqman Rizal](https://github.com/drpsyko101).

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