Add examples for all props in all SDDS baseline SDC YAML files

Fix filename.

Here's another example of XB component examples where there are multiples:

    name:
      type: string
      title: Name
      description: The badge’s theme variant.
      default: primary
      enum:
        - 'moon-stars-fill'
        - 'moon-stars'
        - 'star-fill'
        - 'star'
        - 'stars'
        - 'rocket-fill'
        - 'rocket-takeoff-fill'
        - 'rocket-takeoff'
        - 'rocket'
      examples:
        [
          'moon-stars-fill',
          'moon-stars',
          'star-fill',
          'star',
          'stars',
          'rocket-fill',
          'rocket-takeoff-fill',
          'rocket-takeoff',
          'rocket',
        ]
    label:
      type: string
      title: Label
      description: An alternate description to use for assistive devices. If omitted, the icon will be considered presentational and ignored by assistive devices.
      default: 'This is an icon'
      examples: ['This is an icon']
    size:
      type: string
      title: Size
      description: The icon size.
      default: ''
      enum:
        - ''
        - base
        - l
        - s
        - xs
        - xxs
      examples: ['', 'base', 'l', 's', 'xs', 'xxs']

Thanks!

annmarysruthy → changed the visibility of the branch 3469523-add-examples-for to hidden.

annmarysruthy → changed the visibility of the branch 3469523-add-examples-for to active.

Oh! I didn't notice the changes were there... I'll try to look soon. Thanks!

Assigning to Jacob for first review.

Whoops... off to Jacob :D

kristen pol → credited jacobadeutsch → .

It was a bit painful, but I've merged in recent changes.

fixed some yml enum mistakes that should have been previously resolved

I've scanned it... some things:

I saw this:

components/01-atoms/image/image.component.yml

    url:
      type: string
      title: Url
      description: URL of the image.
      examples:
        - true

so the url example needs to change.

And there are several:

components/02-molecules/accordion/accordion.component.yml
components/02-molecules/next-step/next-step.component.yml
components/02-molecules/tabs/tabs.component.yml
components/02-molecules/tag-list/tag-list.component.yml

      description: 'Vertical spacing: top, bottom, both.'
      enum:
        - top
        - bottom
        - both
      examples:
        - none

so the "none" needs to change to be one of the options.

The default got wiped out here:

starshot_demo/components/00-base/starshot-container/starshot-container.component.yml

      description: Margin, with top, bottom or both vertical spaces.
      default: none
      description: 'Margin vertical spacing: top, bottom, both.'
      enum:
        - top
        - bottom
        - both

Also, this branch will need to be tested on your local to make sure there are no fatal errors.

@kristenpol added examples for properties in all component.yml files of theme and subtheme. Kindly review

@annmary… I’m confused… Jacob and I already were working on this today… did you not have all the files in your previous MR? Hopefully you picked up our changes because there were a lot from main branch and other unrelated fixes that needed to get in

@kristenpol Yesterday I raised MR for the component.yml files in atoms, molecules folders of base theme. Today I took latest pull and added examples for remaining component.yml files of base theme and subtheme. Hope you are clear.

Thanks for the clarification. Back to Jacob for #15 and to review new stuff.

got rid of attributes, corrected the errors above, and used yamllint to find and correct some other errors

fixed 4 small remaining errors, they're showing up in XB now!

Merged this last night and now we can see some cool stuff! Thanks!

Note that I did make some tweaks just now as well as added some missing examples and added @todo for some components that don't have them. This will be fixed in a follow up issue.

Automatically closed - issue fixed for 2 weeks with no activity.