TextConfiguration | PhotoEditorSDK

Hierarchy

TextConfiguration

Index

Properties

Optional backgroundColors

backgroundColors: Array<NamedColor>

Defines all available colors that can be applied to text background. The color picker is always added.

Optional canvasActions

canvasActions: Array<EDIT | BRING_TO_FRONT | DUPLICATE | DELETE> = [CanvasAction.EDIT, CanvasAction.BRING_TO_FRONT, CanvasAction.DUPLICATE, CanvasAction.DELETE]

Defines all allowed actions for the sticker tool menu. Only buttons for allowed actions are visible and shown in the given order.

example

// Defaults to:

[CanvasAction.EDIT, CanvasAction.BRING_TO_FRONT, CanvasAction.DUPLICATE, CanvasAction.DELETE]

Optional colors

colors: Array<NamedColor>

Defines all available colors that can be applied to text. The color picker is always added.

Optional disableAutoScaling

disableAutoScaling: boolean = false

Every time the text gets too long, the editor scale the font size to a pleasant size. If this is enabled the scaling for the font size is disabled

example

// Defaults to:

false

Optional fonts

fonts: Array<FontAsset | ExistingItem> = []

Defines all available fonts. New items can be mixed and matched with existing predefined ones.

example

// Defaults to:

[
  { identifier: "imgly_font_open_sans_bold" },
  { identifier: "imgly_font_aleo_bold" },
  { identifier: "imgly_font_amaticsc" },
  { identifier: "imgly_font_bernier_regular" },
  { identifier: "imgly_font_cheque_regular" },
  { identifier: "imgly_font_gagalin_regular" },
  { identifier: "imgly_font_hagin_caps_thin" },
  { identifier: "imgly_font_intro_inline" },
  { identifier: "imgly_font_lobster" },
  { identifier: "imgly_font_nexa_script" },
  { identifier: "imgly_font_ostrich_sans_black" },
  { identifier: "imgly_font_ostrich_sans_bold" },
  { identifier: "imgly_font_panton_blackitalic_caps" },
  { identifier: "imgly_font_panton_lightitalic_caps" },
  { identifier: "imgly_font_perfograma" },
  { identifier: "imgly_font_trash_hand" },
]

Optional maxCharacterLimit

maxCharacterLimit: number

Add an optional maximum amount of letters for the text

Optional minFontSizeForAutoScaling

minFontSizeForAutoScaling: number

Add an optional minimal font size for the auto scaling