@mathers101/react-native-render-rich-text 0.0.0-stage → 0.1.9

package/src/types/TiptapStyle.ts

@@ -0,0 +1,532 @@
+type TextAlign = 'auto' | 'left' | 'right' | 'center' | 'justify';
+
+type ImageResizeMode = 'contain' | 'cover' | 'stretch' | 'center' | 'none';
+
+interface BaseBlockStyle {
+  fontSize?: number;
+  fontFamily?: string;
+  fontWeight?: string;
+  color?: string;
+  marginTop?: number;
+  marginBottom?: number;
+  lineHeight?: number;
+}
+
+interface ParagraphStyle extends BaseBlockStyle {
+  textAlign?: TextAlign;
+}
+
+interface HeadingStyle extends BaseBlockStyle {
+  textAlign?: TextAlign;
+}
+
+/**
+ * Per-type color overrides for a GitHub admonition/alert.
+ */
+export interface AdmonitionColors {
+  /**
+   * Tints the left accent bar, the title label and the icon for this type.
+   * Defaults to the GitHub palette (note=blue, tip=green, important=purple,
+   * warning=amber, caution=red).
+   */
+  color?: string;
+  /**
+   * Fills the callout background. Omitted or empty means transparent (no fill).
+   */
+  backgroundColor?: string;
+}
+
+/**
+ * Color theming for GitHub admonitions/alerts, keyed by type. Nested under
+ * `blockquote` because admonitions inherit the blockquote geometry (borderWidth,
+ * gapWidth, padding, borderRadius, font, spacing) and only override colors.
+ * Requires `flavor="github"` and `md4cFlags.admonitions` enabled (both default on).
+ */
+export interface AdmonitionsStyle {
+  note?: AdmonitionColors;
+  tip?: AdmonitionColors;
+  important?: AdmonitionColors;
+  warning?: AdmonitionColors;
+  caution?: AdmonitionColors;
+}
+
+interface BlockquoteStyle extends BaseBlockStyle {
+  borderColor?: string;
+  borderWidth?: number;
+  gapWidth?: number;
+  backgroundColor?: string;
+  borderRadius?: number;
+  /**
+   * Padding inside the quote, on every side.
+   * @default 10
+   */
+  padding?: number;
+  admonitions?: AdmonitionsStyle;
+}
+
+interface ListStyle extends BaseBlockStyle {
+  bulletColor?: string;
+  bulletSize?: number;
+  /**
+   * Minimum reserved marker column width applied uniformly to bullet, numbered,
+   * and task lists. `0` (the default) means no minimum: bullet and numbered
+   * lists share the width of a two-digit marker (`99.`), and task lists use
+   * the checkbox width.
+   */
+  markerMinWidth?: number;
+  markerColor?: string;
+  markerFontWeight?: string;
+  gapWidth?: number;
+  marginLeft?: number;
+  /**
+   * Vertical spacing between consecutive list items, including nested ones.
+   * Adds no space above the first item or below the last one — the outer
+   * edges are still controlled by `marginTop`/`marginBottom`.
+   * @default 0
+   */
+  itemSpacing?: number;
+}
+
+/**
+ * Per-token syntax highlight colors for fenced code blocks, keyed on the
+ * tree-sitter highlight token types. Any key omitted falls back to the default
+ * palette (Operator/Punctuation/Variable/Embedded inherit the code block's
+ * base `color`). Colors only take visible effect when the optional syntax
+ * highlighting module is compiled in; otherwise code blocks render uncolored.
+ */
+interface CodeBlockSyntaxColors {
+  keyword?: string;
+  /** Color for operator tokens (e.g. `+`, `=>`). */
+  operator?: string;
+  punctuation?: string;
+  string?: string;
+  number?: string;
+  constant?: string;
+  comment?: string;
+  function?: string;
+  type?: string;
+  variable?: string;
+  property?: string;
+  tag?: string;
+  attribute?: string;
+  embedded?: string;
+}
+
+interface CodeBlockStyle extends BaseBlockStyle {
+  backgroundColor?: string;
+  borderColor?: string;
+  borderRadius?: number;
+  borderWidth?: number;
+  padding?: number;
+  syntaxColors?: CodeBlockSyntaxColors;
+}
+
+export interface LinkStyle {
+  fontFamily?: string;
+  color?: string;
+  underline?: boolean;
+  backgroundColor?: string;
+}
+
+export type LinkVariantStyle = LinkStyle & {
+  /** Native atomic presentation. True uses defaults; an object enables overrides. */
+  pill?: boolean | LinkPillStyle;
+};
+
+export interface LinkPillStyle {
+  /** Visible text, also included in the accessible name alongside original link text. */
+  label?: string;
+  /** Local file, bundled asset or `http(s)` URL. A source that fails shows no icon. */
+  iconUri?: string;
+  /**
+   * Tints this variant's icon, keeping its alpha. Omit to keep the image's own colors.
+   * Icons set per link through `linkPillContent` are not tinted by it.
+   */
+  iconTintColor?: string;
+  borderRadius?: number;
+  paddingHorizontal?: number;
+  paddingVertical?: number;
+  /**
+   * Minimum line height of a block (paragraph, list item, heading, quote) that holds
+   * this pill. It applies to every line of that block and only ever raises the block's
+   * own `lineHeight`; it does not size the pill. Use it to keep pills on consecutive
+   * lines apart without loosening text that has no pills. Unset by default.
+   *
+   * For streamed text prefer the block's own `lineHeight`: this one takes effect when a
+   * link completes and becomes a pill, which moves the text around it.
+   */
+  lineHeight?: number;
+  borderWidth?: number;
+  borderColor?: string;
+  /** Maximum width in points/DIP. 0 uses the available text width. */
+  maxWidth?: number;
+}
+
+interface StrongStyle {
+  fontFamily?: string;
+  /**
+   * Controls whether bold is applied on top of the custom fontFamily.
+   * Only relevant when fontFamily is set. Defaults to 'bold'.
+   * Set to 'normal' to use the font face as-is without adding bold.
+   */
+  fontWeight?: 'bold' | 'normal';
+  color?: string;
+}
+
+interface EmphasisStyle {
+  fontFamily?: string;
+  /**
+   * Controls whether italic is applied on top of the custom fontFamily.
+   * Only relevant when fontFamily is set. Defaults to 'italic'.
+   * Set to 'normal' to use the font face as-is without adding italic.
+   */
+  fontStyle?: 'italic' | 'normal';
+  color?: string;
+}
+
+interface StrikethroughStyle {
+  /**
+   * Color of the strikethrough line.
+   * @platform iOS, web
+   */
+  color?: string;
+}
+
+interface UnderlineStyle {
+  /**
+   * Color of the underline.
+   * @platform iOS, web
+   */
+  color?: string;
+}
+
+interface CodeStyle {
+  fontFamily?: string;
+  fontSize?: number;
+  color?: string;
+  backgroundColor?: string;
+  borderColor?: string;
+}
+
+interface MentionStyle {
+  /**
+   * Text color of the `@label` chip.
+   * @default '#1D4ED8'
+   */
+  color?: string;
+  /**
+   * Capsule fill behind the label.
+   * @default '#DBEAFE'
+   */
+  backgroundColor?: string;
+}
+
+interface FactoidStyle {
+  /**
+   * Text color. A `color` attribute on the factoid node replaces this.
+   * @default '#205710'
+   */
+  color?: string;
+  /**
+   * Background color. A `backgroundColor` attribute on the node replaces this.
+   * @default '#9bfc6e'
+   */
+  backgroundColor?: string;
+  /**
+   * Border color. A `borderColor` attribute on the node replaces this.
+   * @default '#23670d'
+   */
+  borderColor?: string;
+}
+
+interface ImageStyle {
+  height?: number;
+  /**
+   * Maximum height the image is fitted into, preserving aspect ratio. When set,
+   * this replaces `height` as the primary sizing knob. Ignored when `aspectRatio`
+   * is set. Sizing precedence: `aspectRatio` > `maxHeight` > `height`.
+   */
+  maxHeight?: number;
+  /**
+   * Width / height ratio (e.g. `16 / 9`). The image fills the available width and
+   * its height is derived from this ratio, ignoring `height`/`maxHeight`.
+   * Sizing precedence: `aspectRatio` > `maxHeight` > `height`.
+   */
+  aspectRatio?: number;
+  /**
+   * How the image fills its box, analogous to React Native `resizeMode` / CSS
+   * `object-fit`. Applies whenever set explicitly, including with a fixed
+   * `height` box. When omitted, block images keep the legacy fill-width
+   * behavior, unless `maxHeight` or `aspectRatio` is set — then it defaults
+   * to `'cover'`.
+   */
+  resizeMode?: ImageResizeMode;
+  borderRadius?: number;
+  marginTop?: number;
+  marginBottom?: number;
+}
+
+interface VideoStyle {
+  marginTop?: number;
+  marginBottom?: number;
+  borderRadius?: number;
+  aspectRatio?: number;
+  backgroundColor?: string;
+}
+
+interface InlineImageStyle {
+  size?: number;
+}
+
+interface ThematicBreakStyle {
+  color?: string;
+  height?: number;
+  marginTop?: number;
+  marginBottom?: number;
+}
+
+interface TableStyle extends BaseBlockStyle {
+  headerFontFamily?: string;
+  headerBackgroundColor?: string;
+  headerTextColor?: string;
+  rowEvenBackgroundColor?: string;
+  rowOddBackgroundColor?: string;
+  borderColor?: string;
+  borderWidth?: number;
+  borderRadius?: number;
+  cellPaddingHorizontal?: number;
+  cellPaddingVertical?: number;
+  horizontalOverflow?: number;
+  /**
+   * Horizontal alignment of the whole table within the container. Only applies
+   * when the table is narrower than the container; tables that overflow and
+   * scroll always start at the table's beginning. When unset, tables keep the
+   * legacy start-aligned placement. On web, setting any value (including
+   * 'left') also makes the table shrink to fit its content instead of filling
+   * the container width.
+   */
+  align?: 'left' | 'center' | 'right';
+}
+
+interface TaskListStyle {
+  checkedColor?: string;
+  borderColor?: string;
+  checkboxSize?: number;
+  checkboxBorderRadius?: number;
+  checkmarkColor?: string;
+  checkedTextColor?: string;
+  checkedStrikethrough?: boolean;
+}
+
+interface MathStyle {
+  fontSize?: number;
+  color?: string;
+  backgroundColor?: string;
+  padding?: number;
+  marginTop?: number;
+  marginBottom?: number;
+  textAlign?: 'left' | 'center' | 'right';
+}
+
+interface InlineMathStyle {
+  color?: string;
+}
+
+interface SpoilerParticlesStyle {
+  /**
+   * Number of particles per 100x100pt area.
+   * Higher values = denser, more opaque concealment.
+   * @default 8
+   */
+  density?: number;
+  /**
+   * Base speed of particle drift in points per second.
+   * @default 20
+   */
+  speed?: number;
+}
+
+interface SpoilerSolidStyle {
+  /**
+   * Corner radius of the solid spoiler overlay rectangles.
+   * @default 4
+   */
+  borderRadius?: number;
+}
+
+interface SpoilerStyle {
+  /** Color used by all presets for the spoiler overlay. */
+  color?: string;
+  /** Particle-preset tuning (only applies when spoilerOverlay='particles'). */
+  particles?: SpoilerParticlesStyle;
+  /** Solid-preset tuning (only applies when spoilerOverlay='solid'). */
+  solid?: SpoilerSolidStyle;
+}
+
+interface SuperscriptStyle {
+  /**
+   * Font size as a fraction of the surrounding text size.
+   * @default 0.75
+   */
+  fontScale?: number;
+  /**
+   * Vertical shift as a fraction of the surrounding text size.
+   * Positive values shift the text upward.
+   * @default 0.35
+   */
+  baselineOffsetScale?: number;
+}
+
+interface SubscriptStyle {
+  /**
+   * Font size as a fraction of the surrounding text size.
+   * @default 0.75
+   */
+  fontScale?: number;
+  /**
+   * Vertical shift as a fraction of the surrounding text size.
+   * Positive values shift the text downward.
+   * @default 0.20
+   */
+  baselineOffsetScale?: number;
+}
+
+interface HighlightStyle {
+  /**
+   * Text color inside the highlight span.
+   * Inherits the surrounding block color when omitted.
+   */
+  color?: string;
+  /**
+   * Background color of the highlight span.
+   * @default '#FEF08A'
+   */
+  backgroundColor?: string;
+}
+
+export interface TiptapStyle {
+  paragraph?: ParagraphStyle;
+  h1?: HeadingStyle;
+  h2?: HeadingStyle;
+  h3?: HeadingStyle;
+  h4?: HeadingStyle;
+  h5?: HeadingStyle;
+  h6?: HeadingStyle;
+  blockquote?: BlockquoteStyle;
+  list?: ListStyle;
+  codeBlock?: CodeBlockStyle;
+  link?: LinkStyle;
+  /**
+   * Per-URL-pattern link style overrides. Each key is a regex string tested
+   * against the full URL. Patterns are normalized longest-first so more
+   * specific patterns take precedence.
+   *
+   * `color` and `underline` inherit from the base `link` style when omitted.
+   * `backgroundColor` defaults to `transparent`.
+   * `fontFamily` inherits the base `link` family and can be overridden per variant.
+   * `pill: true` enables atomic native presentation with optional label, icon, and geometry.
+   *
+   * @example
+   * linkVariants: {
+   *   '^user:':    { color: '#1A73E8', backgroundColor: '#E8F0FE' },
+   *   '^channel:': { color: '#137333', backgroundColor: '#E6F4EA' },
+   *   '^cite:':    { color: '#B06000', backgroundColor: '#FEF3C7' },
+   *   // path-based: matches any https URL with /user/ in the path
+   *   '\\/user\\/': { color: '#4F46E5', backgroundColor: '#EEF2FF' },
+   * }
+   */
+  linkVariants?: Record<string, LinkVariantStyle>;
+  strong?: StrongStyle;
+  em?: EmphasisStyle;
+  strikethrough?: StrikethroughStyle;
+  underline?: UnderlineStyle;
+  code?: CodeStyle;
+  /**
+   * Inline `@mention` chip. `color` is the label, `backgroundColor` is the capsule.
+   * A mention is an atom: it has no children, and the text is `@` plus `label`
+   * (or `id` when `label` is blank).
+   */
+  mention?: MentionStyle;
+  factoid?: FactoidStyle;
+  image?: ImageStyle;
+  video?: VideoStyle;
+  inlineImage?: InlineImageStyle;
+  thematicBreak?: ThematicBreakStyle;
+  table?: TableStyle;
+  taskList?: TaskListStyle;
+  math?: MathStyle;
+  inlineMath?: InlineMathStyle;
+  spoiler?: SpoilerStyle;
+  superscript?: SuperscriptStyle;
+  subscript?: SubscriptStyle;
+  highlight?: HighlightStyle;
+}
+
+/**
+ * MD4C parser flags configuration.
+ * Controls how the Tiptap parser interprets certain syntax.
+ */
+export interface Md4cFlags {
+  /**
+   * Enable underline syntax support (_text_).
+   * When enabled, underscores are treated as underline markers.
+   * When disabled, underscores are treated as emphasis markers (same as asterisks).
+   * @default false
+   */
+  underline?: boolean;
+  /**
+   * Enable superscript span parsing (^text^).
+   * When enabled, the parser recognizes caret superscript delimiters.
+   * When disabled, carets are treated as plain text.
+   * @default false
+   */
+  superscript?: boolean;
+  /**
+   * Enable subscript span parsing (~text~).
+   * When enabled, single tildes are treated as subscript markers.
+   * When disabled, single and double tildes are treated as strikethrough markers.
+   * @default false
+   */
+  subscript?: boolean;
+  /**
+   * Enable LaTeX math span parsing ($..$ and $$..$$).
+   * When enabled, the parser recognizes LaTeX math delimiters.
+   * When disabled, dollar signs are treated as plain text.
+   * Requires the optional RaTeX native dependency (iOS and Android).
+   * @default true
+   */
+  latexMath?: boolean;
+  /**
+   * Enable highlight span parsing (==text==).
+   * When enabled, double equals are treated as highlight markers.
+   * When disabled, equals signs are treated as plain text.
+   * @default false
+   */
+  highlight?: boolean;
+  /**
+   * Treat soft breaks (single newlines) as hard breaks (visible line breaks).
+   * When enabled, a single newline in the source renders as a line break
+   * instead of being collapsed to a space (CommonMark default).
+   * @default false
+   */
+  hardSoftBreaks?: boolean;
+  /**
+   * Preserve runs of consecutive blank lines from the source instead of
+   * collapsing them into a single paragraph break. Each blank line renders as
+   * one empty line, so the output keeps the exact line count that was typed.
+   * Extra block spacing still comes from the paragraph style - set the paragraph
+   * margins to 0 in tiptapStyle for spacing driven purely by blank lines.
+   * @default false
+   */
+  preserveBlankLines?: boolean;
+  /**
+   * Enable GitHub-style admonitions/alerts (`> [!NOTE]`, `> [!TIP]`,
+   * `> [!IMPORTANT]`, `> [!WARNING]`, `> [!CAUTION]`).
+   * When enabled, such blockquotes render as themed callouts with an icon +
+   * title header (see `tiptapStyle.blockquote.admonitions`).
+   * Only takes effect with `flavor="github"`; forced off for `flavor="commonmark"`,
+   * where the syntax renders as a plain blockquote.
+   * @default true
+   */
+  admonitions?: boolean;
+}