docsifyjs / docsifyjs/docsify

Add a `dispose()` method to `Docsify` to clean up the instance

Abierto
#1,719 0 comentarios 0 reacciones 0 asignados Ver en GitHub
enhancement
Lenguaje dominante
JavaScript
Estrellas
31.5k
Forks
5.8k
Merge medio
9 d 8 h
PR fusionados (30 d)
2

Descripción

## Feature request

Add a `dispose()` method so that `Docsify` can be cleaned up when no longer needed.

#### What problem does this feature solve?

This is needed for embedding Docsify (https://github.com/docsifyjs/docsify/issues/799) on sites that switch to and from a view that has a Docsify instance (maybe they have multiple Docsify instances on different pages).

People currently can not clean up the instance when they will no longer render it.

#### What does the proposed API look like?

```js
// later
window.$docsify.dispose() // or similar
```

and for people who will use the `Docsify` class directly,

```js
const docsify = new Docsify(...)

// later
docsify.dispose()
```

#### How should this be implemented in your opinion?

Add a dispose method that cleans up route change listeners, anchor link click handlers, etc.

Guía de contribución

Abrir la guía de contribución

Evaluación

Este issue todavía no se ha evaluado.

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.