Function RealmProvider

  • RealmProvider(props, context?): null | ReactElement<any, any>

  • The Provider component that is required to wrap any component using the Realm hooks.

    Parameters

    • props: ProviderProps

      The Realm.Configuration for this Realm, passed as props. By default, this is the main configuration for the Realm.

    • Optional context: any

    Returns null | ReactElement<any, any>

    Example

    const AppRoot = () => {
      const syncConfig = {
        flexible: true,
        user: currentUser
      };

      return (
        <RealmProvider schema={[Task, User]} path={"data.realm"} sync={syncConfig}>
          <App/>
        </RealmProvider>
      )
    }

Properties

contextTypes? defaultProps? displayName? propTypes?

Properties

Optional contextTypes

contextTypes?: ValidationMap<any>

Optional defaultProps

defaultProps?: Partial<ProviderProps>

Optional displayName

displayName?: string

Optional propTypes

propTypes?: WeakValidationMap<ProviderProps>

Settings

Theme

On This Page

Generated using TypeDoc