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

Document and update Cauldron behaviors / utils #1782

Open
scurker opened this issue Jan 2, 2025 · 0 comments
Open

Document and update Cauldron behaviors / utils #1782

scurker opened this issue Jan 2, 2025 · 0 comments
Labels
rfc An issue proposing a new significant change tech debt
Milestone

Comments

@scurker
Copy link
Member

scurker commented Jan 2, 2025

We have a few Cauldron utilities that are undocumented but exported:

export { default as AriaIsolate } from './utils/aria-isolate';
export { default as focusableSelector } from './utils/focusable-selector';
export { default as useDidUpdate } from './utils/use-did-update';

Since these are part of our public api, we cannot significantly modify these exported utils without potentially causing breaking changes. We should properly document any "behaviors" we want to include as a part of Cauldron as well as set the expected usage of these utilities. This will require a proposal that should include:

  • How these behaviors should be written (hooks vs non-hooks)
  • When a function should be written as a behavior
  • How these behaviors should be exported from Cauldron

It may be expected that removing some of these existing utilities that may not need to be exported may result in breaking changes and should be included in the proposal on how we will minimize the risk.

@scurker scurker added rfc An issue proposing a new significant change tech debt labels Jan 2, 2025
@scurker scurker added this to the Future milestone Jan 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
rfc An issue proposing a new significant change tech debt
Projects
None yet
Development

No branches or pull requests

1 participant