Function rendererProps

  • Constructs a props declaration for Vue components which can be used for registered renderers and cells. These are typically used in combination with one of the provided bindings, e.g. 'useJsonFormsControl'.

    Use the generic type parameter when using a specialized binding, e.g. rendererProps<Layout>() in combination with useJsonFormsLayout or rendererProps<ControlElement>() in combination with useJsonFormsControl.

    Type Parameters

    • U = UISchemaElement

    Returns {
        cells: {
            default: undefined;
            required: boolean;
            type: PropType<JsonFormsCellRendererRegistryEntry[]>;
        };
        config: {
            default: undefined;
            required: boolean;
            type: ObjectConstructor;
        };
        enabled: {
            default: undefined;
            required: false;
            type: BooleanConstructor;
        };
        path: {
            required: true;
            type: StringConstructor;
        };
        renderers: {
            default: undefined;
            required: boolean;
            type: PropType<JsonFormsRendererRegistryEntry[]>;
        };
        schema: {
            required: true;
            type: PropType<JsonSchema>;
        };
        uischema: {
            required: true;
            type: PropType<U>;
        };
    }

    • cells: {
          default: undefined;
          required: boolean;
          type: PropType<JsonFormsCellRendererRegistryEntry[]>;
      }
      • default: undefined
      • required: boolean
      • type: PropType<JsonFormsCellRendererRegistryEntry[]>
    • config: {
          default: undefined;
          required: boolean;
          type: ObjectConstructor;
      }
      • default: undefined
      • required: boolean
      • type: ObjectConstructor
    • enabled: {
          default: undefined;
          required: false;
          type: BooleanConstructor;
      }
      • default: undefined
      • required: false
      • type: BooleanConstructor
    • path: {
          required: true;
          type: StringConstructor;
      }
      • required: true
      • type: StringConstructor
    • renderers: {
          default: undefined;
          required: boolean;
          type: PropType<JsonFormsRendererRegistryEntry[]>;
      }
      • default: undefined
      • required: boolean
      • type: PropType<JsonFormsRendererRegistryEntry[]>
    • schema: {
          required: true;
          type: PropType<JsonSchema>;
      }
      • required: true
      • type: PropType<JsonSchema>
    • uischema: {
          required: true;
          type: PropType<U>;
      }
      • required: true
      • type: PropType<U>

Generated using TypeDoc