vue-final-modal icon indicating copy to clipboard operation
vue-final-modal copied to clipboard

refactor(docs): rewrite the Component API as table

Open mesqueeb opened this issue 4 years ago • 0 comments

@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 Props page into a table in Component API page
    • PS: what does this mean? v-model is necessary when you open a modal with $vfm.show(name). at the name prop description?
  • [x] Refactor the Events page into a table in Component API page
  • [x] Refactor the Slots page into a table in Component API page
  • [ ] Rewrite the $vfm API page
    • no need for VModal HOC in here
    • unnecessary info in tips
  • [ ] Rewrite sections of the Dynamic Modal docs
    • currently really difficult to understand. Must be simplified greatly
  • [x] Rename Getting Started to Installation and 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 Transitions page.
  • [ ] Finish writing the Showing/Hiding Modals page
  • [ ] Add some explanation on $vfm API page 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 Dialog example page
  • [ ] Update the use-case: Fullscreen to cover (1) use VFM provided HOC (2) setup your own HOC
  • [ ] Update the use-case: Confirmation Dialog to cover (1) use VFM provided helper function (2) setup your own in template (3) setup your own with a dynamic modal
  • [ ] Move Toast to the bottom (I think it should take less priority)
  • [ ] Update the use-case: 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?)
  • [ ] Update the use-case: Panel to cover (1) use VFM provided HOC (2) setup your own HOC
  • [ ] Update the use-case: Drawer to cover (1) use VFM provided HOC (2) setup your own HOC

Nice to have (low priority)

  • [ ] Add option to view Step by Step Basics with either WindiCSS OR custom CSS
  • [ ] Update the use-case: Toast to cover (1) use VFM provided helper function (2) setup your own in template (3) setup your own with a dynamic modal
  • [ ] Update the Params page to make sense... I really don't understand anything on that page currently XD

mesqueeb avatar Oct 10 '21 01:10 mesqueeb