-
Notifications
You must be signed in to change notification settings - Fork 1.8k
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
docs: update modal state manager examples #6806
docs: update modal state manager examples #6806
Conversation
Deploy preview for carbon-elements ready! Built with commit b130b2f |
Deploy preview for carbon-components-react ready! Built with commit b130b2f https://deploy-preview-6806--carbon-components-react.netlify.app |
@emyarod I think your suggestion to remove it from the exports makes a ton of sense, if you have a sec would appreciate if you added that into the WIP component updates for v11 👀 (Just started consolidating there) Would it similarly make sense to drop the docs for the component and steer them towards the correct/intended solution? |
I think it still makes sense to have some documentation around an example (I added one in #6804) but an explicit export like ModalWrapper may no longer be needed in the library should I use this PR to deprecate ModalWrapper then? |
@emyarod definitely your call, whatever makes the most sense! |
ok, I think it makes sense to deprecate the component export in the next major version and keep something in storybook for users to reference as an example |
b31245f
to
287e0ea
Compare
287e0ea
to
9183a4d
Compare
bump @aledavila when you get a chance today 👀 |
Closes #6591
This PR updates the MDX docs for Modal and ComposedModal to remove references to ModalWrapper which should be deprecated in the future. ModalWrapper is a simple state manager for modals which was not initially meant to be exported and is now replaced by storybook examples under Modal and ComposedModal
Testing / Reviewing
Review the updated modal and composed modal storybook Docs tabs updates