basxsoftwareassociation / bread

Engine to create database applications based on Django and the IBM Carbon Design System
BSD 3-Clause "New" or "Revised" License
19 stars 2 forks source link

Extend widgetpreview to contain preview for more components #130

Closed saemideluxe closed 2 years ago

saemideluxe commented 2 years ago

The widgets preview is very useful for a) quickly checking if widgets are rendered correctly and b) to give new developers an idea what form components we have available.

This should be extended to most other components as well. The widgetpreview view should be changed to be named "componentpreview" and contain five tabs. Each tab contains examples of different components. I suggest we use one tile (not expandable) per component class. One tile can contain multiple examples of the same component with different options. And each tile should have a two-column layout: In the first column we show the component examples and in the second we display the docstring of the components init method. That way we can also easily see which components are still missing good docstrings.

Here is the list of tabs and which modules should go into which tab:

  1. Layout components
    • grid.py
    • tabs.py
    • modal.py
    • tile.py
  2. Informational components
    • icon.py
    • tag.py
    • loading.py
    • progress_indicator.py
    • tooltip.py
    • notification.py
  3. Interactive components
    • button.py
    • content_switcher.py
    • toggle.py
    • overflow_menu.py
    • pagination.py
    • searchbar.py
  4. Datatable
    • datatable.py
  5. Form components
    • content of current widgetspreview
dward2nd commented 2 years ago

Because this one is a bit long and detailed, it is best to keep tracking the progress so we can all see how it's been going.

  1. Layout components
  1. Informational components
  1. Interactive components
  1. Datatable
  1. Form components