Skip to content

UpdateOptions ​

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

shouldUpdate ​

If there are multiple sheets active with the same id, you can provide this function to select which sheet to update based on current payload or other sheet data.

Parameters:

sheet

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

TypeRequired
{id: string, context: string, ref: ActionSheetRef}false

Released under the MIT License.