# @types/readmore-js

> TypeScript definitions for readmore-js

Latest version **3.0.5** (published 2026-03-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/readmore-js
pnpm add @types/readmore-js
yarn add @types/readmore-js
bun add @types/readmore-js
```

## Health

**Score 65/100 (B)** — status: stable.

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

Warnings: low downloads; no esm support.

## Facts

| | |
|---|---|
| Version | 3.0.5 |
| Published | 2026-03-16 |
| First published | 2019-04-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 5.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51445 |
| Maintainers | types |

## Links

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

## Recent versions

- 3.0.5 (latest) — 2026-03-16
- 3.0.4 (ts4.5) — 2023-11-07
- 3.0.1 (ts3.6) — 2021-07-08
- 3.0.0 (ts2.0) — 2019-04-29
- 3.0.3 — 2023-10-18
- 3.0.2 — 2023-09-27

## README

# Installation
> `npm install --save @types/readmore-js`

# Summary
This package contains type definitions for readmore-js (https://github.com/jedfoster/Readmore.js).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/readmore-js.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/readmore-js/index.d.ts)
````ts
declare class Readmore {
    constructor(element: string | Element | NodeList, options?: Readmore.Options);

    toggle(element: null | string | Element | NodeList): void;

    destroy(): void;
}

declare namespace Readmore {
    interface Options {
        speed?: number | undefined; // 100 in milliseconds
        collapsedHeight?: number | undefined; // 200 in pixels
        heightMargin?: number | undefined; // 16 in pixels, avoids collapsing blocks that are only slightly larger than collapsedHeight
        moreLink?: ((element: Element) => string) | string | undefined; // HTML string for the "more" toggle link; also accepts a callback function that returns an HTML string
        lessLink?: ((element: Element) => string) | string | undefined; // HTML string for the "less" toggle link; also accepts a callback function that returns an HTML string
        embedCSS?: boolean | undefined; // insert required CSS dynamically, set this to false if you include the necessary CSS in a stylesheet
        blockCSS?: string | undefined; // sets the styling of the blocks, ignored if embedCSS is false
        startOpen?: boolean | undefined;
        sourceOrder?: "after" | "before" | undefined;
        beforeToggle?: ((trigger: Element, element: Element, expanded: boolean) => void) | undefined; // called once per block during initilization after Readmore.js has processed the block
        afterToggle?: ((trigger: Element, element: Element, expanded: boolean) => void) | undefined; // called after a more or less link is clicked, but before the block is collapsed or expanded
        blockProcessed?: ((element: Element, collapsable: boolean) => void) | undefined; // called after the block is collapsed or expanded
    }
}
export = Readmore;

````

### Additional Details
 * Last updated: Mon, 16 Mar 2026 23:07:30 GMT
 * Dependencies: none

# Credits
These definitions were written by .

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