refactor(docs): rewrite the Component API as table #165
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
@hunterliu1003
This is the branch I want to do more refactoring on.
It's only to be merged into
v3/vitepress
after:Planned improvements (please approve)
Props
page into a table inComponent API
pagev-model is necessary when you open a modal with $vfm.show(name).
at thename
prop description?Events
page into a table inComponent API
pageSlots
page into a table inComponent API
pageVModal
HOC in hereGetting Started
toInstallation
and remove unnecessary & confusing informationCustom Modal Transitions
page.$vfm API
page on why it's useful (see Showing/Hiding Modals)Confirmation Dialog
example pageFullscreen
to cover (1) use VFM provided HOC (2) setup your own HOCConfirmation Dialog
to cover (1) use VFM provided helper function (2) setup your own in template (3) setup your own with a dynamic modalToast
to the bottom (I think it should take less priority)Custom Modal Transitions
to cover (1) add your own custom CSS transitions (2) use WindiCSS transition classes (3) use animate.css classes (maybe ?) (could VFM include tree-shakable transition classes?)Panel
to cover (1) use VFM provided HOC (2) setup your own HOCDrawer
to cover (1) use VFM provided HOC (2) setup your own HOCNice to have (low priority)
Step by Step Basics
with either WindiCSS OR custom CSSToast
to cover (1) use VFM provided helper function (2) setup your own in template (3) setup your own with a dynamic modalParams
page to make sense... I really don't understand anything on that page currently XD