docsifyjs / docsifyjs/docsify

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

オープン
#1,719 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る
enhancement
主要言語
JavaScript
スター
31.5k
フォーク
5.8k
平均マージ
9日 8時間
マージ済み PR(30日)
2

説明

## 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.

コントリビューションガイド

コントリビューションガイドを開く

評価

この issue はまだ評価されていません。

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。