Function useUIOverrides

  • Main composable for UI overrides Provides reactive access to override resolution utilities

    Parameters

    Returns {
        getOverriddenComponent: (<K>(key: K, defaultComponent: Component) => Component);
        getOverriddenFunction: (<K>(key: K, defaultFn: ((...args: any[]) => any)) => ((...args: any[]) => any));
        hasOverride: ((key: keyof MediasfuUICustomOverrides) => boolean);
        createConditionalRenderer: (<P>(key: keyof MediasfuUICustomOverrides, defaultComponent: Component<P>) => ((props: P) => VNode<RendererNode, RendererElement, {
            [key: string]: any;
        }>));
        overrides: undefined | MediasfuUICustomOverrides;
    }

    • getOverriddenComponent: (<K>(key: K, defaultComponent: Component) => Component)
        • <K>(key, defaultComponent): Component
        • Get a resolved component for a specific override key

          Type Parameters

          Parameters

          • key: K
          • defaultComponent: Component

          Returns Component

    • getOverriddenFunction: (<K>(key: K, defaultFn: ((...args: any[]) => any)) => ((...args: any[]) => any))
        • <K>(key, defaultFn): ((...args: any[]) => any)
        • Get a resolved function for a specific override key

          Type Parameters

          Parameters

          • key: K
          • defaultFn: ((...args: any[]) => any)
              • (...args): any
              • Parameters

                • Rest...args: any[]

                Returns any

          Returns ((...args: any[]) => any)

            • (...args): any
            • Parameters

              • Rest...args: any[]

              Returns any

    • hasOverride: ((key: keyof MediasfuUICustomOverrides) => boolean)
    • createConditionalRenderer: (<P>(key: keyof MediasfuUICustomOverrides, defaultComponent: Component<P>) => ((props: P) => VNode<RendererNode, RendererElement, {
          [key: string]: any;
      }>))
        • <P>(key, defaultComponent): ((props: P) => VNode<RendererNode, RendererElement, {
              [key: string]: any;
          }>)
        • Create a render function that conditionally uses override or default

          Type Parameters

          • P extends Record<string, unknown>

          Parameters

          Returns ((props: P) => VNode<RendererNode, RendererElement, {
              [key: string]: any;
          }>)

            • (props): VNode<RendererNode, RendererElement, {
                  [key: string]: any;
              }>
            • Parameters

              • props: P

              Returns VNode<RendererNode, RendererElement, {
                  [key: string]: any;
              }>

    • overrides: undefined | MediasfuUICustomOverrides