• Preparing search index...
  • The search index is not available
Yank Note Api - v3.82.1
  • Yank Note Api
  • renderer/context/lib
  • vue
  • defineCustomElement

Function defineCustomElement

  • defineCustomElement<Props, RawBindings>(setup, options?): VueElementConstructor<Props>
  • Type Parameters

    • Props
    • RawBindings = object

    Parameters

    • setup: ((props: Props, ctx: SetupContext) => RenderFunction | RawBindings)
        • (props, ctx): RenderFunction | RawBindings
        • Parameters

          • props: Props
          • ctx: SetupContext

          Returns RenderFunction | RawBindings

    • Optionaloptions: Pick<ComponentOptions, "name" | "inheritAttrs" | "emits"> & CustomElementOptions & {
          props?: (keyof Props)[];
      }

    Returns VueElementConstructor<Props>

    • Defined in node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:98
  • defineCustomElement<Props, RawBindings>(setup, options?): VueElementConstructor<Props>
  • Type Parameters

    • Props
    • RawBindings = object

    Parameters

    • setup: ((props: Props, ctx: SetupContext) => RenderFunction | RawBindings)
        • (props, ctx): RenderFunction | RawBindings
        • Parameters

          • props: Props
          • ctx: SetupContext

          Returns RenderFunction | RawBindings

    • Optionaloptions: Pick<ComponentOptions, "name" | "inheritAttrs" | "emits"> & CustomElementOptions & {
          props?: ComponentObjectPropsOptions<Props>;
      }

    Returns VueElementConstructor<Props>

    • Defined in node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:101
  • defineCustomElement<RuntimePropsOptions, PropsKeys, RuntimeEmitsOptions, EmitsKeys, Data, SetupBindings, Computed, Methods, Mixin, Extends, InjectOptions, InjectKeys, Slots, LocalComponents, Directives, Exposed, Provide, InferredProps, ResolvedProps>(options, extraOptions?): VueElementConstructor<ResolvedProps>
  • Type Parameters

    • RuntimePropsOptions extends ComponentObjectPropsOptions<Data> = ComponentObjectPropsOptions<Data>
    • PropsKeys extends string = string
    • RuntimeEmitsOptions extends EmitsOptions = {}
    • EmitsKeys extends string = string
    • Data = {}
    • SetupBindings = {}
    • Computed extends ComputedOptions = {}
    • Methods extends MethodOptions = {}
    • Mixin extends ComponentOptionsMixin = ComponentOptionsMixin
    • Extends extends ComponentOptionsMixin = ComponentOptionsMixin
    • InjectOptions extends ComponentInjectOptions = {}
    • InjectKeys extends string = string
    • Slots extends SlotsType = {}
    • LocalComponents extends Record<string, Component> = {}
    • Directives extends Record<string, vue.Directive> = {}
    • Exposed extends string = string
    • Provide extends ComponentProvideOptions = ComponentProvideOptions
    • InferredProps = string extends PropsKeys
          ? ComponentObjectPropsOptions<Data> extends RuntimePropsOptions
              ? {}
              : ExtractPropTypes<RuntimePropsOptions>
          : {
              [key in string]?: any
          }
    • ResolvedProps = InferredProps & EmitsToProps<RuntimeEmitsOptions>

    Parameters

    • options: CustomElementOptions & {
          props?: RuntimePropsOptions & ThisType<void> | PropsKeys[];
      } & ComponentOptionsBase<ResolvedProps, SetupBindings, Data, Computed, Methods, Mixin, Extends, RuntimeEmitsOptions, EmitsKeys, {}, InjectOptions, InjectKeys, Slots, LocalComponents, Directives, Exposed, Provide> & ThisType<CreateComponentPublicInstanceWithMixins<Readonly<ResolvedProps>, SetupBindings, Data, Computed, Methods, Mixin, Extends, RuntimeEmitsOptions, EmitsKeys, {}, false, InjectOptions, Slots, LocalComponents, Directives, Exposed>>
    • OptionalextraOptions: CustomElementOptions

    Returns VueElementConstructor<ResolvedProps>

    • Defined in node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:104
  • defineCustomElement<T>(options, extraOptions?): VueElementConstructor<T extends DefineComponent<infer P, any, any, any>
        ? P
        : unknown>
  • Type Parameters

    • T extends (new (...args: any[]) => any)

    Parameters

    • options: T
    • OptionalextraOptions: CustomElementOptions

    Returns VueElementConstructor<T extends DefineComponent<infer P, any, any, any>
        ? P
        : unknown>

    • Defined in node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:110

Settings

Member Visibility
Yank Note Api - v3.82.1
  • Loading...

Generated using TypeDoc