rtfbuilder/demo/examples/navigation.ts at main · nitrotm/rtfbuilder · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
import { pt, RichTextDocumentBuilder, RTFCharacterFormatting } from "../../lib"

const builder = new RichTextDocumentBuilder()

// Add colors for links and headings
builder.withColor("linkBlue", { red: 0, green: 0, blue: 255 })
builder.withColor("headingBlue", { red: 0, green: 0, blue: 139 })
builder.withColor("gray", { red: 100, green: 100, blue: 100 })

// Add fonts
builder.withFont("arial", { name: "Arial", family: "swiss" })
builder.withFont("courier", { name: "Courier New", family: "modern" })

const linkStyle: Partial<RTFCharacterFormatting> = { colorAlias: "linkBlue", underline: true }

// Create main section
builder.withSection((section) => {
  section.body.withTitle("RTF Navigation Demo: Hyperlinks & Bookmarks", "top")
  section.body.withText("This document demonstrates hyperlink and bookmark functionality in RTF documents.").closeParagraph()

  section.body.withHeading("Table of Contents", 1)
  section.body.withText("Click on any link below to jump to the corresponding section:").closeParagraph()
  section.body.withParagraph((p) => {
    p.spaceBefore(pt(10))
      .withBookmarkLink("intro", "1. Introduction to Bookmarks", linkStyle)
      .withText({ special: "lineBreak" })
      .withBookmarkLink("external", "2. External Links", linkStyle)
      .withText({ special: "lineBreak" })
      .withBookmarkLink("email", "3. Email Links", linkStyle)
      .withText({ special: "lineBreak" })
      .withBookmarkLink("files", "4. File Links", linkStyle)
  })
})

// Create new section for page break effect
builder.withSection((section) => {
  section.body.withHeading("1. Introduction to Bookmarks", 1, "intro")
  section.body
    .withText(
      "Bookmarks allow you to create navigation points within your RTF document. They work in conjunction with hyperlinks to enable readers to jump directly to specific sections."
    )
    .closeParagraph()

  section.body.withHeading("Key Features:", 2)
  section.body.withList((list) => {
    list.newItem().withText("Named anchors within the document")
    list.newItem().withText("Can be referenced by hyperlinks using #bookmarkname")
    list.newItem().withText("Invisible in the rendered document")
    list.newItem().withText("Supported by most RTF readers")
  })
  section.body.newParagraph().spaceBefore(pt(20)).withBookmarkLink("top", "← Back to Table of Contents", linkStyle)
})

// Section 2: External Links
builder.withSection((section) => {
  section.body.withHeading("2. External Links", 1, "external")
  section.body
    .withText("RTF documents can contain hyperlinks to external resources such as websites, making them interactive and connected to online content.")
    .closeParagraph()

  section.body.withHeading("Web Links:", 2)
  section.body.withText("Visit ").withExternalLink("https://www.example.com", "Example.com", linkStyle).withText(" for more information.").closeParagraph()
  section.body.newParagraph().spaceBefore(pt(20)).withBookmarkLink("top", "← Back to Table of Contents", linkStyle)
})

// Section 3: Email Links
builder.withSection((section) => {
  section.body.withHeading("3. Email Links", 1, "email")
  section.body.withText("RTF supports mailto links that open the default email client with pre-filled information.").closeParagraph()

  section.body.withHeading("Simple Email Link:", 2)
  section.body.withParagraph((p) =>
    p.withText("Contact us at ").withChunk((c) => c.emailLink("support@example.com").with(linkStyle).text("support@example.com"))
  )
  section.body.withHeading("Email with Subject:", 2)
  section.body.withParagraph((p) =>
    p.withText("Send feedback: ").withChunk((c) => c.emailLink("feedback@example.com", "RTF Document Feedback").with(linkStyle).text("feedback@example.com"))
  )
  section.body.withHeading("Email with Subject and Body:", 2)
  section.body.withParagraph((p) =>
    p.withChunk((c) => c.emailLink("info@example.com", "Question", 'Hello, I have a "question" about...').with(linkStyle).text("Send a pre-composed email"))
  )
  section.body.closeParagraph()
  section.body.newParagraph().spaceBefore(pt(20)).withBookmarkLink("top", "← Back to Table of Contents", linkStyle)
})

// Section 4: File Links
builder.withSection((section) => {
  section.body.withHeading("4. File Links", 1, "files")
  section.body.withText("Link to local files or network resources (support varies by RTF reader).").closeParagraph()

  section.body.withHeading("Local File Examples:", 2)
  section.body
    .withText("• Open ")
    .withExternalLink("file://./simple.rtf", "Local Document", linkStyle)
    .withText(" (simple.rtf in current directory)")
    .closeParagraph()
  section.body.withHeading("Note:", 2)
  section.body
    .withText("File links may not work in all RTF readers due to security restrictions. Some readers may require user confirmation before opening local files.")
    .closeParagraph()
  section.body.newParagraph().spaceBefore(pt(20)).withBookmarkLink("top", "← Back to Table of Contents", linkStyle)
})

export default builder