Files
docx-js/docs/usage/text.md

90 lines
1.2 KiB
Markdown
Raw Normal View History

2018-08-04 03:28:27 +01:00
# Text
2019-08-03 13:42:24 +01:00
You can add multiple `text runs` in `Paragraphs`. This is the most verbose way of writing a `Paragraph` but it is also the most flexible:
2018-08-04 03:28:27 +01:00
```js
2019-08-03 13:42:24 +01:00
import { Paragraph, Text } from "docx";
const paragraph = new Paragraph({
children: [
new TextRun("My awesome text here for my university dissertation"),
],
});
2018-08-04 03:28:27 +01:00
```
Text objects have methods inside which changes the way the text is displayed.
## Typographical Emphasis
More info [here](https://english.stackexchange.com/questions/97081/what-is-the-typography-term-which-refers-to-the-usage-of-bold-italics-and-unde)
### Bold
```js
text.bold();
```
### Italics
```js
text.italics();
2018-08-04 03:28:27 +01:00
```
### Underline
```js
text.underline();
```
### Strike through
```js
text.strike();
```
### Double strike through
```js
text.doubleStrike();
```
### Superscript
```js
text.superScript();
```
### Subscript
```js
text.subScript();
```
### All Capitals
```js
text.allCaps();
```
### Small Capitals
```js
text.smallCaps();
```
## Break
Sometimes you would want to put text underneath another line of text but inside the same paragraph.
```js
text.break();
```
## Chaining
What if you want to create a paragraph which is **_bold_** and **_italic_**?
```js
paragraph.bold().italics();
2018-08-04 03:28:27 +01:00
```