Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Can't find documentation for plugin.registerHook #157

Open
MoamenAbdelsattar opened this issue Nov 5, 2024 · 2 comments
Open

Can't find documentation for plugin.registerHook #157

MoamenAbdelsattar opened this issue Nov 5, 2024 · 2 comments

Comments

@MoamenAbdelsattar
Copy link

I want to migrate from Paged.js to Vivliostyle.js, and I wrote hooks to run at atBreakToken and at renderNode to modify breaks of my document. Vivliostyle documentation doesn't provide information about types of hooks available.

@MurakamiShinyu
Copy link
Member

Thank you for your question. Unfortunately, the documentation for plugin.registerHook and its usage examples are found only in the source code of Vivliostyle.js. See the source code https://github.com/vivliostyle/vivliostyle.js/blob/master/packages/core/src/vivliostyle/plugin.ts and find the usage of plugin.registerHook. Several vivliostyle features have been added by using plugin.registerHook mechanism. The following pull requests may be helpful as examples:

@MoamenAbdelsattar
Copy link
Author

MoamenAbdelsattar commented Nov 6, 2024

Thank you! Those documentation and examples are enough for me. I hope , however, there is a plan to put the documentation in the website.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants