@uniformdev/canvas-vue 19.198.3-alpha.3 → 19.199.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -1,5 +1,5 @@
1
1
  import * as vue_demi from 'vue-demi';
2
- import { PropType, ConcreteComponent, Ref, ComputedRef } from 'vue-demi';
2
+ import { PropType, ConcreteComponent, Ref, ComputedRef, VNode, Slot } from 'vue-demi';
3
3
  import { ComponentInstance, ComponentParameter, RootComponentInstance, UpdateCompositionMessage, SubscribeToCompositionOptions } from '@uniformdev/canvas';
4
4
  export { GetParameterAttributesProps, createUniformApiEnhancer, getParameterAttributes } from '@uniformdev/canvas';
5
5
  import { RichTextNode } from '@uniformdev/richtext';
@@ -597,6 +597,10 @@ declare const TextRichTextNode: RichTextRendererComponent;
597
597
  type UniformRichTextProps = {
598
598
  parameterId: string;
599
599
  resolveRichTextRenderer?: RenderRichTextComponentResolver;
600
+ /**
601
+ * The name of the HTML tag to render, to wrap the children of the rich text.
602
+ */
603
+ as?: keyof HTMLElementTagNameMap;
600
604
  /**
601
605
  * Sets the value to show in Canvas editor when the parameter value is empty.
602
606
  * Can be a static string, or a function to generate the placeholder out of parameter info.
@@ -615,12 +619,16 @@ declare const UniformRichText: vue_demi.DefineComponent<{
615
619
  type: PropType<UniformRichTextProps["resolveRichTextRenderer"]>;
616
620
  required: false;
617
621
  };
622
+ as: {
623
+ type: PropType<UniformRichTextProps["as"]>;
624
+ required: false;
625
+ };
618
626
  placeholder: {
619
627
  type: PropType<UniformRichTextProps["placeholder"]>;
620
628
  };
621
- }, (() => vue_demi.VNode<vue_demi.RendererNode, vue_demi.RendererElement, {
629
+ }, (() => null) | (() => VNode<vue_demi.RendererNode, vue_demi.RendererElement, {
622
630
  [key: string]: any;
623
- }>) | (() => null) | null, unknown, {}, {}, vue_demi.ComponentOptionsMixin, vue_demi.ComponentOptionsMixin, {}, string, vue_demi.VNodeProps & vue_demi.AllowedComponentProps & vue_demi.ComponentCustomProps, Readonly<vue_demi.ExtractPropTypes<{
631
+ }>) | null, unknown, {}, {}, vue_demi.ComponentOptionsMixin, vue_demi.ComponentOptionsMixin, {}, string, vue_demi.VNodeProps & vue_demi.AllowedComponentProps & vue_demi.ComponentCustomProps, Readonly<vue_demi.ExtractPropTypes<{
624
632
  parameterId: {
625
633
  type: StringConstructor;
626
634
  required: true;
@@ -629,6 +637,10 @@ declare const UniformRichText: vue_demi.DefineComponent<{
629
637
  type: PropType<UniformRichTextProps["resolveRichTextRenderer"]>;
630
638
  required: false;
631
639
  };
640
+ as: {
641
+ type: PropType<UniformRichTextProps["as"]>;
642
+ required: false;
643
+ };
632
644
  placeholder: {
633
645
  type: PropType<UniformRichTextProps["placeholder"]>;
634
646
  };
@@ -689,6 +701,15 @@ declare const UniformSlot: vue_demi.DefineComponent<{
689
701
  type: PropType<UniformSlotProps["resolveRenderer"]>;
690
702
  };
691
703
  }>>, {}, {}>;
704
+ declare function renderComponent({ component, resolveRenderer, indexInSlot, slotName, parentComponent, slotChildrenCount, emptyPlaceholder, }: {
705
+ component: ComponentInstance;
706
+ resolveRenderer?: ResolveRenderer;
707
+ indexInSlot?: number;
708
+ slotName?: string;
709
+ parentComponent?: ComponentInstance;
710
+ slotChildrenCount?: number;
711
+ emptyPlaceholder?: Slot;
712
+ }): ConcreteComponent<any>;
692
713
 
693
714
  type UseCompositionEventEffectOptions = Omit<Partial<SubscribeToCompositionOptions>, 'callback' | 'compositionId'> & {
694
715
  compositionIdRef: Ref<SubscribeToCompositionOptions['compositionId']>;
@@ -708,4 +729,4 @@ declare const globalCompositionEnhancerInjectionKey = "uniformGlobalCompositionE
708
729
  */
709
730
  declare function convertComponentToProps<T = unknown>(component: ComponentInstance): ComponentProps<T>;
710
731
 
711
- export { type ComponentProps, DefaultNotImplementedComponent, type DefaultNotImplementedComponentProps, HeadingRichTextNode, LinkRichTextNode, ListItemRichTextNode, ListRichTextNode, ParagraphRichTextNode, type PersonalizeComponent, QuoteRichTextNode, type RenderRichTextComponentResolver, type ResolveRenderer, type RichTextComponentProps, type RichTextRendererComponent, RootRichTextNode, TableCellRichTextNode, TableRichTextNode, TableRowRichTextNode, type TestComponent, TextRichTextNode, UniformComponent, type UniformComponentProps, UniformComposition, type UniformCompositionProps, UniformPlayground, type UniformPlaygroundProps, UniformRichText, UniformRichTextNode, type UniformRichTextNodeProps, type UniformRichTextProps, UniformSlot, type UniformSlotProps, UniformText, type UniformTextProps, type UseCompositionEventEffectOptions, type UseUniformContextualEditingProps, convertComponentToProps, globalCompositionEnhancerInjectionKey, useCompositionEventEffect, useUniformContextualEditing, useUniformCurrentComponent, useUniformCurrentComposition };
732
+ export { type ComponentProps, DefaultNotImplementedComponent, type DefaultNotImplementedComponentProps, HeadingRichTextNode, LinkRichTextNode, ListItemRichTextNode, ListRichTextNode, ParagraphRichTextNode, type PersonalizeComponent, QuoteRichTextNode, type RenderRichTextComponentResolver, type ResolveRenderer, type RichTextComponentProps, type RichTextRendererComponent, RootRichTextNode, TableCellRichTextNode, TableRichTextNode, TableRowRichTextNode, type TestComponent, TextRichTextNode, UniformComponent, type UniformComponentProps, UniformComposition, type UniformCompositionProps, UniformPlayground, type UniformPlaygroundProps, UniformRichText, UniformRichTextNode, type UniformRichTextNodeProps, type UniformRichTextProps, UniformSlot, type UniformSlotProps, UniformText, type UniformTextProps, type UseCompositionEventEffectOptions, type UseUniformContextualEditingProps, convertComponentToProps, globalCompositionEnhancerInjectionKey, renderComponent, useCompositionEventEffect, useUniformContextualEditing, useUniformCurrentComponent, useUniformCurrentComposition };
package/dist/index.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import * as vue_demi from 'vue-demi';
2
- import { PropType, ConcreteComponent, Ref, ComputedRef } from 'vue-demi';
2
+ import { PropType, ConcreteComponent, Ref, ComputedRef, VNode, Slot } from 'vue-demi';
3
3
  import { ComponentInstance, ComponentParameter, RootComponentInstance, UpdateCompositionMessage, SubscribeToCompositionOptions } from '@uniformdev/canvas';
4
4
  export { GetParameterAttributesProps, createUniformApiEnhancer, getParameterAttributes } from '@uniformdev/canvas';
5
5
  import { RichTextNode } from '@uniformdev/richtext';
@@ -597,6 +597,10 @@ declare const TextRichTextNode: RichTextRendererComponent;
597
597
  type UniformRichTextProps = {
598
598
  parameterId: string;
599
599
  resolveRichTextRenderer?: RenderRichTextComponentResolver;
600
+ /**
601
+ * The name of the HTML tag to render, to wrap the children of the rich text.
602
+ */
603
+ as?: keyof HTMLElementTagNameMap;
600
604
  /**
601
605
  * Sets the value to show in Canvas editor when the parameter value is empty.
602
606
  * Can be a static string, or a function to generate the placeholder out of parameter info.
@@ -615,12 +619,16 @@ declare const UniformRichText: vue_demi.DefineComponent<{
615
619
  type: PropType<UniformRichTextProps["resolveRichTextRenderer"]>;
616
620
  required: false;
617
621
  };
622
+ as: {
623
+ type: PropType<UniformRichTextProps["as"]>;
624
+ required: false;
625
+ };
618
626
  placeholder: {
619
627
  type: PropType<UniformRichTextProps["placeholder"]>;
620
628
  };
621
- }, (() => vue_demi.VNode<vue_demi.RendererNode, vue_demi.RendererElement, {
629
+ }, (() => null) | (() => VNode<vue_demi.RendererNode, vue_demi.RendererElement, {
622
630
  [key: string]: any;
623
- }>) | (() => null) | null, unknown, {}, {}, vue_demi.ComponentOptionsMixin, vue_demi.ComponentOptionsMixin, {}, string, vue_demi.VNodeProps & vue_demi.AllowedComponentProps & vue_demi.ComponentCustomProps, Readonly<vue_demi.ExtractPropTypes<{
631
+ }>) | null, unknown, {}, {}, vue_demi.ComponentOptionsMixin, vue_demi.ComponentOptionsMixin, {}, string, vue_demi.VNodeProps & vue_demi.AllowedComponentProps & vue_demi.ComponentCustomProps, Readonly<vue_demi.ExtractPropTypes<{
624
632
  parameterId: {
625
633
  type: StringConstructor;
626
634
  required: true;
@@ -629,6 +637,10 @@ declare const UniformRichText: vue_demi.DefineComponent<{
629
637
  type: PropType<UniformRichTextProps["resolveRichTextRenderer"]>;
630
638
  required: false;
631
639
  };
640
+ as: {
641
+ type: PropType<UniformRichTextProps["as"]>;
642
+ required: false;
643
+ };
632
644
  placeholder: {
633
645
  type: PropType<UniformRichTextProps["placeholder"]>;
634
646
  };
@@ -689,6 +701,15 @@ declare const UniformSlot: vue_demi.DefineComponent<{
689
701
  type: PropType<UniformSlotProps["resolveRenderer"]>;
690
702
  };
691
703
  }>>, {}, {}>;
704
+ declare function renderComponent({ component, resolveRenderer, indexInSlot, slotName, parentComponent, slotChildrenCount, emptyPlaceholder, }: {
705
+ component: ComponentInstance;
706
+ resolveRenderer?: ResolveRenderer;
707
+ indexInSlot?: number;
708
+ slotName?: string;
709
+ parentComponent?: ComponentInstance;
710
+ slotChildrenCount?: number;
711
+ emptyPlaceholder?: Slot;
712
+ }): ConcreteComponent<any>;
692
713
 
693
714
  type UseCompositionEventEffectOptions = Omit<Partial<SubscribeToCompositionOptions>, 'callback' | 'compositionId'> & {
694
715
  compositionIdRef: Ref<SubscribeToCompositionOptions['compositionId']>;
@@ -708,4 +729,4 @@ declare const globalCompositionEnhancerInjectionKey = "uniformGlobalCompositionE
708
729
  */
709
730
  declare function convertComponentToProps<T = unknown>(component: ComponentInstance): ComponentProps<T>;
710
731
 
711
- export { type ComponentProps, DefaultNotImplementedComponent, type DefaultNotImplementedComponentProps, HeadingRichTextNode, LinkRichTextNode, ListItemRichTextNode, ListRichTextNode, ParagraphRichTextNode, type PersonalizeComponent, QuoteRichTextNode, type RenderRichTextComponentResolver, type ResolveRenderer, type RichTextComponentProps, type RichTextRendererComponent, RootRichTextNode, TableCellRichTextNode, TableRichTextNode, TableRowRichTextNode, type TestComponent, TextRichTextNode, UniformComponent, type UniformComponentProps, UniformComposition, type UniformCompositionProps, UniformPlayground, type UniformPlaygroundProps, UniformRichText, UniformRichTextNode, type UniformRichTextNodeProps, type UniformRichTextProps, UniformSlot, type UniformSlotProps, UniformText, type UniformTextProps, type UseCompositionEventEffectOptions, type UseUniformContextualEditingProps, convertComponentToProps, globalCompositionEnhancerInjectionKey, useCompositionEventEffect, useUniformContextualEditing, useUniformCurrentComponent, useUniformCurrentComposition };
732
+ export { type ComponentProps, DefaultNotImplementedComponent, type DefaultNotImplementedComponentProps, HeadingRichTextNode, LinkRichTextNode, ListItemRichTextNode, ListRichTextNode, ParagraphRichTextNode, type PersonalizeComponent, QuoteRichTextNode, type RenderRichTextComponentResolver, type ResolveRenderer, type RichTextComponentProps, type RichTextRendererComponent, RootRichTextNode, TableCellRichTextNode, TableRichTextNode, TableRowRichTextNode, type TestComponent, TextRichTextNode, UniformComponent, type UniformComponentProps, UniformComposition, type UniformCompositionProps, UniformPlayground, type UniformPlaygroundProps, UniformRichText, UniformRichTextNode, type UniformRichTextNodeProps, type UniformRichTextProps, UniformSlot, type UniformSlotProps, UniformText, type UniformTextProps, type UseCompositionEventEffectOptions, type UseUniformContextualEditingProps, convertComponentToProps, globalCompositionEnhancerInjectionKey, renderComponent, useCompositionEventEffect, useUniformContextualEditing, useUniformCurrentComponent, useUniformCurrentComposition };