etn-ccis / blui-react-component-library

Re-usable React components for use in Brightlayer UI applications
BSD 3-Clause "New" or "Revised" License
16 stars 10 forks source link

Update drawerRailItem to use SharedStyleProps only #861

Open JeffGreiner-eaton opened 5 months ago

JeffGreiner-eaton commented 5 months ago

Describe the bug / expected behavior

The docs incorrectly state that the DrawerRailItem supports sharedProps — it does not support all of the styles that are listed there....it only supports a subset of them. In the docs, we're showing both SharedStyleProps & NavItemSharedStyleProps as the shared props. DrawerRailItem only supports the SharedStyleProps. In the playground component, we are showing inputs/knobs for those props that are not supported and they are being spread down to the DrawerRailItem, which doesn't know what they are.

We have set a filter in the drawer rail Item playground here to clear the console warnings. https://github.com/etn-ccis/blui-react-component-library/blob/b6dae00bda5bb14071a0cada2a699509a36d205c/docs/src/componentDocs/DrawerRailItem/playground/PlaygroundPage.tsx#L81

What are the steps to reproduce?

  1. Go to...
  2. Click on...

Screenshots / Screen recording

Code snippet / Link to minimum reproduction example

CODE HERE

Your environment information

Suggested fix

Anything else to add?