Add SymbolRun to allow adding symbols inline
This commit is contained in:
@ -2,7 +2,7 @@
|
||||
|
||||
> Everything (text, images, graphs etc) in OpenXML is organised in paragraphs.
|
||||
|
||||
!> Paragraphs requires an understanding of [Sections](usage/sections.md).
|
||||
!> Paragraphs requires an understanding of [Sections](sections.md).
|
||||
|
||||
You can create `Paragraphs` in the following ways:
|
||||
|
||||
@ -16,11 +16,15 @@ const paragraph = new Paragraph("Short hand Hello World");
|
||||
|
||||
### Children Method
|
||||
|
||||
This method is useful for adding different `text` with different styles or adding `images` inline.
|
||||
This method is useful for adding different [text](text.md) with different styles, [symbols](symbols.md), or adding [images](images.md) inline.
|
||||
|
||||
```ts
|
||||
const paragraph = new Paragraph({
|
||||
children: [new TextRun("Lorem Ipsum Foo Bar"), new TextRun("Hello World")],
|
||||
children: [
|
||||
new TextRun("Lorem Ipsum Foo Bar"),
|
||||
new TextRun("Hello World"),
|
||||
new SymbolRun("F071"),
|
||||
],
|
||||
});
|
||||
```
|
||||
|
||||
|
53
docs/usage/symbols.md
Normal file
53
docs/usage/symbols.md
Normal file
@ -0,0 +1,53 @@
|
||||
# Symbol Runs
|
||||
|
||||
!> SymbolRuns require an understanding of [Paragraphs](paragraph.md).
|
||||
|
||||
You can add multiple `symbol runs` in `Paragraphs` along with [text runs](text.md) using the Paragraph's `children` property.
|
||||
|
||||
```ts
|
||||
import { Paragraph, TextRun, SymbolRun } from "docx";
|
||||
|
||||
const paragraph = new Paragraph({
|
||||
children: [
|
||||
new TextRun("This is a checkbox: "),
|
||||
new SymbolRun("F071")
|
||||
],
|
||||
});
|
||||
```
|
||||
|
||||
## Specifying symbol font
|
||||
|
||||
By default symbol runs will use the `Wingdings` font. To switch fonts, pass an object instead of a string to the `SymbolRun` constructor and specify `char` and `symbolfont` properties:
|
||||
|
||||
```ts
|
||||
const symbol = new SymbolRun({
|
||||
char: "F071",
|
||||
symbolfont: "Arial",
|
||||
});
|
||||
```
|
||||
|
||||
## Example symbols
|
||||
|
||||
Symbols are specified by their hexidecimal code. Ref http://officeopenxml.com/WPtextSpecialContent-symbol.php. Below are some examples.
|
||||
|
||||
- `F071`: empty checkbox
|
||||
- `F043`: thumbs up
|
||||
- `F04A`: smile
|
||||
- `F04C`: frown
|
||||
- `F022`: scissors
|
||||
- `F0F0`: right arrow
|
||||
- `F0FE`: checked box
|
||||
|
||||
## Typographical Emphasis
|
||||
|
||||
Symbol runs can have their display modified just like text runs. For example, they can be bolded and italicized:
|
||||
|
||||
```ts
|
||||
const symbol = new SymbolRun({
|
||||
char: "F071",
|
||||
bold: true,
|
||||
italics: true,
|
||||
});
|
||||
```
|
||||
|
||||
See the [text run](text.md) documentation for more info.
|
Reference in New Issue
Block a user