sandstone icon indicating copy to clipboard operation
sandstone copied to clipboard

WRR-381: Updated docs of `aria-label` prop in PageViews, QuickGuidePanels and added `css` prop in PageViews to clean up APIs of PageViews and QuickGuidePanels

Open juwonjeong opened this issue 5 months ago • 4 comments

Checklist

  • [x] I have read and understand the contribution guide
  • [ ] A CHANGELOG entry is included
  • [x] At least one test case is included for this feature or bug fix
  • [x] Documentation was added or is not needed
  • [ ] This is an API breaking change

Issue Resolved / Feature Added

  • In PageViews and QuickGuidePanels, aria-label prop needs to have more proper documentation. -> PageView does not need aria-label prop because it will be set in PageViews.Page and QuickGuidePanels needs to have aria-label as private prop because it will also be set in QuickGuidePanels.Panel.
  • Add css prop in PageViews to allow customizing the component
  • Make onClose and closeButtonAriaLabel props of PageViews to be public.

Resolution

Remove unnecessary aria-label prop in PageViews and add private aria-label prop documentation in QuickGuidePanels. Add aria-prop documentation in PageViews.Page and QuickGuidePanels.Panel. Make onClose and closeButtonAriaLabel prop in PageViews to be public Add css prop in PageViews to allow customizing the component instead of using navigationButtonOffset prop.

Additional Considerations

In QuickGuidePanels and WizardPanels, I fixed the typo PrevButton -> prevButton

Links

WRR-381

Comments

juwonjeong avatar Sep 23 '24 09:09 juwonjeong