List of hooks

[peterpeterparker]

Assuming there are some, is the list of available hooks exposed by Docusaurus documented somewhere?

I'm trying to find a way to get the document metadata from a custom component, and I assume there should be a hook for that. However, I haven’t found any documentation.

[slorber]

We have many hooks, but those undoucmented are considered internal and not part of the public API surface.

We may try to maintain retrocompatibility on most of them (because some users swizzle our React components), but with no guarantee. Documenting them all and exposing them as public api surface limits our ability to change things without releasing a new major version.

See also our release process: https://docusaurus.io/community/release-process

This hook may be what you look for, and afaik we don't plan to refactor it in the near future:

import {useDoc} from '@docusaurus/plugin-content-docs/client';

const {metadata} = useDoc();

You can find similar hooks exposed in other plugins (@docusaurus/plugin-content-blog/client), and we also have @docusaurus/theme-common (retrocompatible) and @docusaurus/theme-common/internal (may break)

[peterpeterparker]

Makes sense. Though, it would be nice to have some documentation for those that are public, such as the one you mentioned or not make them public at all. But I guess that would require some API-breaking changes, so I understand.

Thanks for the answer nevertheless!

[slorber]

@peterpeterparker, the hook I mentioned is currently not public, so we don't document it on purpose. Now as you asked, and it's unlikely to change much, I shared it anyway.

All public hooks are already documented. It's just that public hooks alone don't cover your use-case.

We'll likely expose and document this hook in the future, but it might require adjusting the data structure we expose first. If we make it public now, it becomes impossible to adjust that data structure without a major release.