Update static options prototype to include props param (#6452)

The static options field can either be a concrete options object or a generator function which accepts props as parameter. Unfortunately, static fields don't play well with TypeScript generics and the param was left as `any`.
wix · Aug 2, 2020 · 813c1a2 · 813c1a2
1 parent 85264c1
commit 813c1a2
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/lib/src/interfaces/NavigationComponent.ts b/lib/src/interfaces/NavigationComponent.ts
@@ -18,7 +18,13 @@ export class NavigationComponent<Props = {}, State = {}, Snapshot = any> extends
   State,
   Snapshot
 > {
-  static options?: (() => Options) | Options;
+  /**
+   * Options used to apply a style configuration when the screen appears.
+   *
+   * This field can either contain the concrete options to be applied, or a generator function
+   * which accepts props and returns an Options object.
+   */
+  static options: ((props?: any) => Options) | Options;
 
   componentDidAppear(_event: ComponentDidAppearEvent) {}
   componentDidDisappear(_event: ComponentDidDisappearEvent) {}