Skip to content

Types

SealKit is written in TypeScript and exports all public types.

Component Types

tsx
import type {
  SealCanvasProps,
  SealCanvasRef,
  SealRendererProps,
  SealRendererRef
} from '@luohuax/seal-kit'

Template Types

tsx
import type {
  SealTemplateConfig,
  ShapeConfig,
  LayoutConfig,
  FieldConfig,
  StyleConfig,
  EffectsConfig,
  ExportConfig,
  ComplianceConfig
} from '@luohuax/seal-kit'

Shape and Layout

tsx
import type {
  SealShapeType,
  BorderStyle,
  InnerDivider,
  LayoutType,
  ReadingOrder
} from '@luohuax/seal-kit'
  • SealShapeType: "circle" | "square" | "rectangle"
  • BorderStyle: "none" | "single" | "double"
  • InnerDivider: "none" | "horizontalLine"
  • LayoutType: "singleVertical" | "tripleHorizontal" | "grid2x3" | "grid2x2" | "centerImage" | "dateStamp" | "kakuin"
  • ReadingOrder: "rtl-ttb" | "ltr-ttb"

Field and Value Types

tsx
import type {
  FieldInputType,
  FieldOption,
  FontOption,
  SealFieldValues,
  SealExportOptions
} from '@luohuax/seal-kit'
  • FieldInputType: "text" | "textarea" | "select" | "date" | "color" | "radio" | "slider" | "image"
  • SealFieldValues: a record of field values accepted by SealRenderer
  • SealExportOptions: export format options including format, resolution, transparent, and filename

Preset Types

tsx
import type { PresetName } from '@luohuax/seal-kit'

PresetName is a union of the built-in preset keys.

Font Types

tsx
import type { FontRegistration } from '@luohuax/seal-kit'

Used with registerFont() to define custom or Google Font sources.

Released under the MIT License.