Skip to content

Commit 0eda44e

Browse files
authored
docs: update onSelectEvent prop story (#2492)
1 parent f3c070c commit 0eda44e

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

stories/props/onSelectEvent.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ import LinkTo from '@storybook/addon-links/react'
77

88
Callback fired when a calendar event is selected (i.e.: an `onClick` handler).
99

10+
The method receives the selected event as a parameter. If using <LinkTo kind="props" story="resources">resources</LinkTo>, and are in a TimeGrid view ('day' or 'week'), the `event` will have an additional `sourceResource` property containing the resource object that the event is associated with.
11+
12+
Clicking on a <LinkTo kind="props" story="backgroundEvents">backgroundEvent</LinkTo> will also fire the `onSelectEvent` callback. It will also receive the `backgroundEvent` as the `event` object, but contain a `isBackgroundEvent` property set to `true`. This will allow you to distinguish between a background event and a regular event within your `onSelectEvent` handler.
13+
1014
**Note:** The <LinkTo kind="props" story="selectable">selectable</LinkTo> prop is _not_ required for this prop to function.
1115

1216
**Important:** The event passed into the function is the Calendar Event, not the SyntheticEvent expected by most click handlers.

0 commit comments

Comments
 (0)