vue-final-modal
vue-final-modal copied to clipboard
refactor(docs): rewrite the Component API as table
@hunterliu1003
This is the branch I want to do more refactoring on.
It's only to be merged into v3/vitepress after:
- [ ] merging this PR: https://github.com/vue-final/vue-final-modal/pull/164
- [ ] finishing all other todo's below
Planned improvements (please approve)
- [x] Refactor the
Propspage into a table inComponent APIpage- PS: what does this mean?
v-model is necessary when you open a modal with $vfm.show(name).at thenameprop description?
- PS: what does this mean?
- [x] Refactor the
Eventspage into a table inComponent APIpage - [x] Refactor the
Slotspage into a table inComponent APIpage - [ ] Rewrite the $vfm API page
- no need for
VModalHOC in here - unnecessary info in tips
- no need for
- [ ] Rewrite sections of the Dynamic Modal docs
- currently really difficult to understand. Must be simplified greatly
- [x] Rename
Getting StartedtoInstallationand remove unnecessary & confusing information - [ ] Add section on Styling: Custom CSS example
- [ ] Add section on Styling: WindiCSS example
- [ ] Add section on Styling: Tailwind CSS example
- [ ] Add section on Styling: Bulma CSS example
- [ ] Add section on Styling: Transitions! → and link to the
Custom Modal Transitionspage. - [ ] Finish writing the Showing/Hiding Modals page
- [ ] Add some explanation on
$vfm APIpage on why it's useful (see Showing/Hiding Modals) - [ ] Add explanation on why dynamic modals are useful: Eg. Confirmation Dialog (perfect use case for Dynamic modals!) And link to the
Confirmation Dialogexample page - [ ] Update the use-case:
Fullscreento cover (1) use VFM provided HOC (2) setup your own HOC - [ ] Update the use-case:
Confirmation Dialogto cover (1) use VFM provided helper function (2) setup your own in template (3) setup your own with a dynamic modal - [ ] Move
Toastto the bottom (I think it should take less priority) - [ ] Update the use-case:
Custom Modal Transitionsto 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?) - [ ] Update the use-case:
Panelto cover (1) use VFM provided HOC (2) setup your own HOC - [ ] Update the use-case:
Drawerto cover (1) use VFM provided HOC (2) setup your own HOC
Nice to have (low priority)
- [ ] Add option to view
Step by Step Basicswith either WindiCSS OR custom CSS - [ ] Update the use-case:
Toastto cover (1) use VFM provided helper function (2) setup your own in template (3) setup your own with a dynamic modal - [ ] Update the
Paramspage to make sense... I really don't understand anything on that page currently XD