vira - v28.12.2
    Preparing search index...

    Function renderDynamicElement

    • Renders the current state of a dynamic element loader. This should go in your render function. Make sure to also use createDynamicElementLoader to create a dynamic loader in your element's state.

      Type Parameters

      Parameters

      • asyncProp: DynamicElementAsyncProp<Loaders>
      • __namedParameters: {
            key?: NoInfer<keyof Loaders>;
            error(this: void, error: Error): ErrorReturnValue;
            loading(
                this: void,
                params: Promise<
                    If<
                        IsAny<
                            {
                                [Key in string
                                | number
                                | symbol]: Awaited<ReturnType<NoInfer<Loaders>[Key]>>
                            },
                        >,
                        any,
                        If<
                            IsNever<
                                {
                                    [Key in string
                                    | number
                                    | symbol]: Awaited<ReturnType<NoInfer<Loaders>[Key]>>
                                },
                            >,
                            never,
                            If<
                                IsNever<NoInfer<keyof Loaders>>,
                                never,
                                _RequireExactlyOne<
                                    {
                                        [Key in string
                                        | number
                                        | symbol]: Awaited<ReturnType<NoInfer<(...)>[Key]>>
                                    },
                                    If<
                                        IsAny<NoInfer<keyof Loaders>>,
                                        NoInfer<keyof Loaders>,
                                        NoInfer<keyof Loaders>,
                                    >,
                                >,
                            >,
                        >,
                    >,
                >,
            ): LoadingReturnValue;
            ready(
                this: void,
                params: If<
                    IsAny<
                        {
                            [Key in string
                            | number
                            | symbol]: Awaited<ReturnType<NoInfer<Loaders>[Key]>>
                        },
                    >,
                >,
            ): ReadyReturnValue;
        }
        • Optionalkey?: NoInfer<keyof Loaders>

          If this is left undefined (or falsy), the current key will not be set, whatever the existing key is will continue to be used.

        • error: function
        • loading: function
          • Parameters

            • this: void
            • params: Promise<
                  If<
                      IsAny<
                          {
                              [Key in string
                              | number
                              | symbol]: Awaited<ReturnType<NoInfer<Loaders>[Key]>>
                          },
                      >,
                      any,
                      If<
                          IsNever<
                              {
                                  [Key in string
                                  | number
                                  | symbol]: Awaited<ReturnType<NoInfer<Loaders>[Key]>>
                              },
                          >,
                          never,
                          If<
                              IsNever<NoInfer<keyof Loaders>>,
                              never,
                              _RequireExactlyOne<
                                  {
                                      [Key in string
                                      | number
                                      | symbol]: Awaited<ReturnType<NoInfer<(...)>[Key]>>
                                  },
                                  If<
                                      IsAny<NoInfer<keyof Loaders>>,
                                      NoInfer<keyof Loaders>,
                                      NoInfer<keyof Loaders>,
                                  >,
                              >,
                          >,
                      >,
                  >,
              >

            Returns LoadingReturnValue

        • ready: function
          • Parameters

            • this: void
            • params: If<
                  IsAny<
                      {
                          [Key in string
                          | number
                          | symbol]: Awaited<ReturnType<NoInfer<Loaders>[Key]>>
                      },
                  >,
              >

            Returns ReadyReturnValue

      Returns LoadingReturnValue | ReadyReturnValue | ErrorReturnValue