ic-design-system icon indicating copy to clipboard operation
ic-design-system copied to clipboard

Introduce more code examples for all components

Open MI6-255 opened this issue 2 years ago • 8 comments

Summary

Introduce more code examples for all components

💬 Description

Go through all components and document:

  • All possible code examples
  • Add more technical guidance (see how other libraries do this)
  • Add imports (may link to a relevant ticket of where imports go design wise)

This will need to be broken up into each component issue wise, so breakup the issue.

  • [ ] #1233
  • [ ] alert
  • [ ] back to top
  • [x] badge
  • [x] breadcrumb
  • [ ] button
  • [ ] card (horizontal)
  • [x] card
  • [ ] checkbox - please at least add an example for nativeIndeterminateBehaviour - example in Storybook "Indeterminate with children"
  • [x] chip
  • [ ] data entity
  • [ ] data table
  • [ ] date input
  • [ ] date picker
  • [ ] dialog
  • [ ] empty state
  • [ ] footer
  • [ ] hero
  • [ ] link
  • [ ] loading indicator
  • [ ] multi-select
  • [ ] page-header
  • [ ] pagination
  • [ ] popover-menu - no sub menu example at the mo
  • [ ] radio button
  • [ ] search bar
  • [ ] section container
  • [ ] select
  • [ ] side navigation
  • [x] skeleton
  • [ ] status tag
  • [ ] stepper
  • [ ] switch
  • [ ] tabs
  • [ ] textfield - also see https://github.com/mi6/ic-design-system/issues/1084
  • [ ] toast
  • [ ] toggle button
  • [ ] tooltip
  • [ ] top nav
  • [ ] tree view

💰 Use value

Make it quicker for teams to build apps using ICDS components.

MI6-255 avatar Sep 25 '23 13:09 MI6-255

To be reviewed with the design team.

ASM995 avatar Sep 28 '23 11:09 ASM995

There is currently no single expansion example for accordion (Raised on behalf of: @GCHQ-Developer-530)

GCHQ-Developer-112 avatar Oct 25 '23 14:10 GCHQ-Developer-112

On hold until #751 is complete.

MI6-654 avatar Apr 23 '24 16:04 MI6-654

This issue is now unblocked

GCHQ-Developer-112 avatar Jun 25 '24 10:06 GCHQ-Developer-112

Initially review per component

MI6-255 avatar Aug 09 '24 09:08 MI6-255

Need examples on how to use all methods such as setFocus

MI6-255 avatar Aug 09 '24 09:08 MI6-255

Linked ticket #1508

gd2910 avatar Jan 10 '25 10:01 gd2910

Linked ticket #1195

gd2910 avatar Jan 24 '25 10:01 gd2910