types

Type Aliases

HTMLSchemaOptions

type HTMLSchemaOptions = {
  sanitize?: {
     allowAttributes?: Record<string, string[]>;
     allowComments?: boolean;
     allowComponents?: boolean;
     allowCustomElements?: boolean;
     allowElements?: string[];
     blockElements?: string[];
     dropAttributes?: Record<string, string[]>;
     dropElements?: string[];
  };
};

Defined in: studiocms/packages/@studiocms/html/src/types.ts:19^

Defines the schema for HTML configuration options.

The schema includes an optional sanitize property, which is validated using the StudioCMSSanitizeOptionsSchema. If no value is provided, the default is an empty object.

Type Declaration

sanitize?

optional sanitize: {
  allowAttributes?: Record<string, string[]>;
  allowComments?: boolean;
  allowComponents?: boolean;
  allowCustomElements?: boolean;
  allowElements?: string[];
  blockElements?: string[];
  dropAttributes?: Record<string, string[]>;
  dropElements?: string[];
} = StudioCMSSanitizeOptionsSchema;

Sanitization options for HTML content. See StudioCMSSanitizeOptionsSchema for details.

sanitize.allowAttributes?

optional allowAttributes: Record<string, string[]>;

sanitize.allowComments?

optional allowComments: boolean;

sanitize.allowComponents?

optional allowComponents: boolean;

sanitize.allowCustomElements?

optional allowCustomElements: boolean;

sanitize.allowElements?

optional allowElements: string[];

sanitize.blockElements?

optional blockElements: string[];

sanitize.dropAttributes?

optional dropAttributes: Record<string, string[]>;

sanitize.dropElements?

optional dropElements: string[];

Variables

HTMLSchema

const HTMLSchema: ZodDefault<HTMLSchemaOptions>;

Defined in: studiocms/packages/@studiocms/html/src/types.ts:11^

Defines the schema for HTML configuration options.

The schema includes an optional sanitize property, which is validated using the StudioCMSSanitizeOptionsSchema. If no value is provided, the default is an empty object.