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

Move away from navigator’s internal methods/properties #25

Open
JayPanoz opened this issue Nov 18, 2024 · 0 comments
Open

Move away from navigator’s internal methods/properties #25

JayPanoz opened this issue Nov 18, 2024 · 0 comments
Assignees
Labels

Comments

@JayPanoz
Copy link
Contributor

JayPanoz commented Nov 18, 2024

Right now we’re using internals to inject scroll affordances (nav._cframes, which is temporarily exposed for lack of APIs but will be made private in the future), but also to inject ReadiumCSS custom properties (see #17).

It should be made clear people should not rely on these private members and the Playground codebase moves away from them as soon as possible.

(As exhaustive as possible) listing of these private members:

  • _cframes
  • frameManager & frameManager.msg.send
  • pool & pool.setPerPage()
  • setReadingProgression()

If possible, developers/implementers of the TS-Toolkit Navigator should not heavily rely on these, and issue a feature request if they need something that is not covered through Injection (injecting into iframe’s content document) and Preferences (user settings) APIs.

In case of doubt, members that are exposed but will become private should be indicated in ts-toolkit src.

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

No branches or pull requests

1 participant