zendeskgarden / react-containers

:seedling: garden React (no-UI) containers

Home Page:https://zendeskgarden.github.io/react-containers/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Show how to init ScheduleContainer in the README example.

deanrad opened this issue · comments

Expectations

I expected to see how to pass props to the ScheduleContainer component in the README.

Reality

The duration:1000 of the hooks example was missing from the component.

Hey 👋 @deanius, thanks for creating the issue.

What exactly is missing from the readme? The code example on the schedule package has an example of passing the duration?

import { ScheduleContainer } from '@zendeskgarden/container-schedule';

<ScheduleContainer duration={1000} delayMS={0}>
  {elapsed => <p>Percentage: {(elapsed * 100).toFixed(0)}%</p>}
</ScheduleContainer>;

Going to close this, let me know if you'd like anything else made clearer. Always happy to receive PRs too to help improve documentation.