floem icon indicating copy to clipboard operation
floem copied to clipboard

Help Wanted: Widget Docs

Open jrmoulton opened this issue 1 year ago • 5 comments

Every widget such as stack, button, dropdown, svg, etc... should have an example as part of their documentation, and ideally on the function that is used to build the view. For Svg this would be the svg function.

As part of the documentation and example, and example of how to build the view along with common styling with relevant styles should also be shown.

jrmoulton avatar Oct 11 '24 02:10 jrmoulton

Which existing widget i would look into as example if i'd start writing docs for those that doesn't have any?

aalhitennf avatar Nov 18 '24 13:11 aalhitennf

widget docs that need work:

  • [ ] radio button
  • [ ] svg
  • [ ] Rich Text
  • [x] Tooltip
  • [x] Toggle Button
  • [x] Text Input
  • [x] Tab
  • [x] Img
  • [x] button
  • [ ] L10n

Ideally each of these can be done one module at a time and each can be marked with #[deny(missing_docs)]

jrmoulton avatar Nov 18 '24 21:11 jrmoulton

@jrmoulton You can mark img module as done in #711;

charlescgs avatar Feb 17 '25 08:02 charlescgs

Hi, maybe have a look here, added documentation for radio_button

AncutaIoan avatar Jul 23 '25 09:07 AncutaIoan

@jrmoulton Docs were added to following modules: button in #928 toggle_button in #927 tooltip in #926 text_input in #925

charlescgs avatar Oct 15 '25 05:10 charlescgs