String Field Type

Ideal for one line small text, will be translated to an html input.

import {
  UltimateEntityFieldTypes,
  UltimateEntityField,
} from "medusa-plugin-ultimate/dist/index";

@UltimateEntityField({
    // required
    type: UltimateEntityFieldTypes.STRING,
    // options
    defaultValue?: string;
    name?: string;
    description?: string;
    note?: string;
    group?: string;
})
@Column({ type: "varchar" })
name: string;

Parameters

type: UltimateEntityFieldTypes.STRING,
defaultValue: (optional)
name: (optional) override field name, will be displayed on the UI as a label.
description: (optional) to give more details about the field, will be displayed on the UI below the input.
note: (optional) displayed as a tooltip when the infos icon is hovered.
group: (optional) fields of the same group are displayed in the same block (details).

Example Use Cases

This field can be used for multiple things

Every single line text

Illustrative Images

Ultimate Entity Field Types Text