Skip to content

Docs don't accurately reflect ThemeProvider ids #401

@seancrater

Description

@seancrater

Expectations

As a user, I'd like the IDs provided in the documentation to match up to what the code is looking for. I was working with the Checkbox component and needed to reverse engineer a bit to figure out that the API had changed to forms.check_label from checkboxes.label which is listed in the docs.

Reality

Expected to see my styles come through, but seems the wrong selectors are documented
image

Steps to Reproduce

  1. Install @zendeskgarden/forms @ 6.20
  2. Create a basic Checkbox (with Label as well) instance with a ThemeProvider wrapping it
  3. Apply some styles using the ID checkboxes.label

Example

https://codesandbox.io/s/garden-create-react-app-72pey?fontsize=14

Fine Print

  • Component: Checkbox (but probably more?)
  • Version: 6.20
  • Browsers: all

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions