Skip to content

ShowOptions ​

payload ​

Any data that you want the action sheet to recieve before it opens. This data will be available in props of action sheet component or in onBeforeShow prop on the `ActionSHeet before the action sheet is presented to the user.

TypeRequired
anyfalse

context ​

Provide the context of the SheetProvider where you want to present the action sheet.

TypeRequired
stringfalse

overrideProps ​

Override a ActionSheet's props that were defined when the component was declared.

tsx
function ExampleSheet(props: SheetProps<'example-sheet'>) {
  return (
    <ActionSheet
      disableElevation={true}
      gestureEnabled
      {...props.overrideProps}
    />
  );
}
TypeRequired
ActionSheetPropsfalse

onClose ​

A callback function that is called when the action sheet closes.

Parameters:

data

Any data that is sent from the hide function of SheetManager can be recieved here.

TypeRequired
functionfalse

snapIndex

Set the snap point for the action sheet on open

TypeRequired
numberfalse

Released under the MIT License.