telega - v0.11.0

telega/format

Provides utilities for text formatting in Telegram messages. Supports HTML, Markdown, and MarkdownV2 parse modes.

Quick Start

import telega/format as fmt

// Simple formatting
let text = fmt.bold("Important!") <> " " <> fmt.italic("Read this")

// Complex formatting with builder
let message = fmt.build()
  |> fmt.text("Hello ")
  |> fmt.bold_text("World")
  |> fmt.line_break()
  |> fmt.link_text("Click here", "https://example.com")
  |> fmt.to_html()

Types

FormatBuilder

opaque </>

Builder pattern for constructing formatted text

pub opaque type FormatBuilder

FormattedText

opaque </>

Formatted text container

pub opaque type FormattedText

ParseMode

</>

Supported parse modes for Telegram

pub type ParseMode {
  HTML
  Markdown
  MarkdownV2
}

Constructors 

  • HTML
  • Markdown
  • MarkdownV2

Values

bold

</> 
pub fn bold(text: String) -> String

Format text as bold (HTML)

bold_text

</> 
pub fn bold_text(
  builder: FormatBuilder,
  text: String,
) -> FormatBuilder

Add bold text using builder

build

</> 
pub fn build() -> FormatBuilder

Create a new format builder with HTML as default

code

</> 
pub fn code(text: String) -> String

Format text as inline code (HTML)

code_text

</> 
pub fn code_text(
  builder: FormatBuilder,
  text: String,
) -> FormatBuilder

Add inline code using builder

custom_emoji_text

</> 
pub fn custom_emoji_text(
  builder: FormatBuilder,
  emoji: String,
  id: String,
) -> FormatBuilder

Add custom emoji using builder

escape_html

</> 
pub fn escape_html(text: String) -> String

Escape special characters for HTML

escape_markdown

</> 
pub fn escape_markdown(text: String) -> String

Escape special characters for Markdown

escape_markdown_v2

</> 
pub fn escape_markdown_v2(text: String) -> String

Escape special characters for MarkdownV2

italic

</> 
pub fn italic(text: String) -> String

Format text as italic (HTML)

italic_text

</> 
pub fn italic_text(
  builder: FormatBuilder,
  text: String,
) -> FormatBuilder

Add italic text using builder

line_break

</> 
pub fn line_break(builder: FormatBuilder) -> FormatBuilder

Add line break

</> 
pub fn link(text: String, url: String) -> String

Format text as hyperlink (HTML)

link_text

</> 
pub fn link_text(
  builder: FormatBuilder,
  text: String,
  url: String,
) -> FormatBuilder

Add hyperlink using builder

mention

</> 
pub fn mention(username: String) -> String

Format text as mention (HTML)

mention_text

</> 
pub fn mention_text(
  builder: FormatBuilder,
  username: String,
) -> FormatBuilder

Add mention using builder

parse_mode_to_string

</> 
pub fn parse_mode_to_string(mode: ParseMode) -> String

Convert ParseMode to string for API

pre

</> 
pub fn pre(
  code: String,
  language: option.Option(String),
) -> String

Format text as code block (HTML)

pre_text

</> 
pub fn pre_text(
  builder: FormatBuilder,
  code: String,
  language: option.Option(String),
) -> FormatBuilder

Add code block using builder

render

</> 
pub fn render(formatted: FormattedText) -> #(String, ParseMode)

Render FormattedText to string with parse mode

spoiler

</> 
pub fn spoiler(text: String) -> String

Format text as spoiler (HTML)

spoiler_text

</> 
pub fn spoiler_text(
  builder: FormatBuilder,
  text: String,
) -> FormatBuilder

Add spoiler text using builder

strikethrough

</> 
pub fn strikethrough(text: String) -> String

Format text as strikethrough (HTML)

strikethrough_text

</> 
pub fn strikethrough_text(
  builder: FormatBuilder,
  text: String,
) -> FormatBuilder

Add strikethrough text using builder

text

</> 
pub fn text(
  builder: FormatBuilder,
  text: String,
) -> FormatBuilder

Add plain text

to_formatted

</> 
pub fn to_formatted(builder: FormatBuilder) -> FormattedText

Convert to FormattedText for use with reply functions

to_html

</> 
pub fn to_html(builder: FormatBuilder) -> String

Build to HTML string

to_markdown

</> 
pub fn to_markdown(builder: FormatBuilder) -> String

Build to Markdown string

to_markdown_v2

</> 
pub fn to_markdown_v2(builder: FormatBuilder) -> String

Build to MarkdownV2 string

underline

</> 
pub fn underline(text: String) -> String

Format text as underline (HTML)

underline_text

</> 
pub fn underline_text(
  builder: FormatBuilder,
  text: String,
) -> FormatBuilder

Add underlined text using builder

with_mode

</> 
pub fn with_mode(
  builder: FormatBuilder,
  mode: ParseMode,
) -> FormatBuilder

Set parse mode for builder

✨ Search Document