Interface Options

bindings/javascript/js-binding.d.ts:9–54

export declare function inlineFragment(html: string, css: string, options?: Options | undefined | null): string

export interface Options {
  /**
   * Whether to inline CSS from "style" tags.
   *
   * Sometimes HTML may include a lot of boilerplate styles, that are not applicable in every
   * scenario, and it is useful to ignore them and use `extra_css` instead.
   */
  inlineStyleTags?: boolean
  /** Keep "style" tags after inlining. */
  keepStyleTags?: boolean
  /** Keep "link" tags after inlining. */
  keepLinkTags?: boolean
  /** Keep "at-rules" after inlining. */
  keepAtRules?: boolean
  /** Remove trailing semicolons and spaces between properties and values. */
  minifyCss?: boolean
  /** Used for loading external stylesheets via relative URLs. */
  baseUrl?: string
  /** Whether remote stylesheets should be loaded or not. */
  loadRemoteStylesheets?: boolean
  /** An LRU Cache for external stylesheets. */
  cache?: StylesheetCache
  /** Additional CSS to inline. */
  extraCss?: string
  /**
   * Pre-allocate capacity for HTML nodes during parsing.
   * It can improve performance when you have an estimate of the number of nodes in your HTML document.
   */
  preallocateNodeCapacity?: number
  /** Remove selectors that were successfully inlined from inline `<style>` blocks. */
  removeInlinedSelectors?: boolean
  /**
   * Apply `width` HTML attributes from CSS `width` properties on supported elements.
   *
   * This is useful for email compatibility with clients like Outlook that ignore CSS width.
   * Supported elements: `table`, `td`, `th`, `img`.
   */
  applyWidthAttributes?: boolean
  /**
   * Apply `height` HTML attributes from CSS `height` properties on supported elements.
   *
   * This is useful for email compatibility with clients like Outlook that ignore CSS height.
   * Supported elements: `table`, `td`, `th`, `img`.
   */
  applyHeightAttributes?: boolean
}

export interface StylesheetCache {
  /** Cache size. */