Nishaninlinetextformatter
@nishans/utils / Exports / InlineTextFormatter
Class: InlineTextFormatter#
A class to add inline text formatters
Hierarchy#
↳ InlineTextFormatter
Index#
Constructors#
Properties#
Accessors#
- blue
- bluebg
- bold
- brown
- brownbg
- code
- default
- defaultbg
- gray
- graybg
- italic
- orange
- orangebg
- pink
- pinkbg
- purple
- purplebg
- red
- redbg
- strikeThrough
- teal
- tealbg
- underline
- yellow
- yellowbg
Methods#
Constructors#
constructor#
+ new InlineTextFormatter(text?: TTextFormat): InlineTextFormatter
Parameters:#
| Name | Type |
|---|---|
text? | TTextFormat |
Returns: InlineTextFormatter
Inherited from: HighlightColors
Defined in: inlineBlocks.ts:140
Properties#
text#
• text: TTextFormat
Inherited from: HighlightColors.text
Defined in: inlineBlocks.ts:43
Accessors#
blue#
• blue(): InlineTextFormatter
Returns: InlineTextFormatter
Defined in: inlineBlocks.ts:80
bluebg#
• bluebg(): InlineTextFormatter
Returns: InlineTextFormatter
Defined in: inlineBlocks.ts:120
bold#
• bold(): InlineTextFormatter
Returns: InlineTextFormatter
Defined in: inlineBlocks.ts:158
brown#
• brown(): InlineTextFormatter
Returns: InlineTextFormatter
Defined in: inlineBlocks.ts:64
brownbg#
• brownbg(): InlineTextFormatter
Returns: InlineTextFormatter
Defined in: inlineBlocks.ts:104
code#
• code(): InlineTextFormatter
Returns: InlineTextFormatter
Defined in: inlineBlocks.ts:154
default#
• default(): InlineTextFormatter
Returns: InlineTextFormatter
Defined in: inlineBlocks.ts:56
defaultbg#
• defaultbg(): InlineTextFormatter
Returns: InlineTextFormatter
Defined in: inlineBlocks.ts:96
gray#
• gray(): InlineTextFormatter
Returns: InlineTextFormatter
Defined in: inlineBlocks.ts:60
graybg#
• graybg(): InlineTextFormatter
Returns: InlineTextFormatter
Defined in: inlineBlocks.ts:100
italic#
• italic(): InlineTextFormatter
Returns: InlineTextFormatter
Defined in: inlineBlocks.ts:162
orange#
• orange(): InlineTextFormatter
Returns: InlineTextFormatter
Defined in: inlineBlocks.ts:68
orangebg#
• orangebg(): InlineTextFormatter
Returns: InlineTextFormatter
Defined in: inlineBlocks.ts:108
pink#
• pink(): InlineTextFormatter
Returns: InlineTextFormatter
Defined in: inlineBlocks.ts:88
pinkbg#
• pinkbg(): InlineTextFormatter
Returns: InlineTextFormatter
Defined in: inlineBlocks.ts:128
purple#
• purple(): InlineTextFormatter
Returns: InlineTextFormatter
Defined in: inlineBlocks.ts:84
purplebg#
• purplebg(): InlineTextFormatter
Returns: InlineTextFormatter
Defined in: inlineBlocks.ts:124
red#
• red(): InlineTextFormatter
Returns: InlineTextFormatter
Defined in: inlineBlocks.ts:92
redbg#
• redbg(): InlineTextFormatter
Returns: InlineTextFormatter
Defined in: inlineBlocks.ts:132
strikeThrough#
• strikeThrough(): InlineTextFormatter
Returns: InlineTextFormatter
Defined in: inlineBlocks.ts:150
teal#
• teal(): InlineTextFormatter
Returns: InlineTextFormatter
Defined in: inlineBlocks.ts:76
tealbg#
• tealbg(): InlineTextFormatter
Returns: InlineTextFormatter
Defined in: inlineBlocks.ts:116
underline#
• underline(): InlineTextFormatter
Returns: InlineTextFormatter
Defined in: inlineBlocks.ts:166
yellow#
• yellow(): InlineTextFormatter
Returns: InlineTextFormatter
Defined in: inlineBlocks.ts:72
yellowbg#
• yellowbg(): InlineTextFormatter
Returns: InlineTextFormatter
Defined in: inlineBlocks.ts:112
Methods#
add#
▸ add(title: string): InlineTextFormatter
Parameters:#
| Name | Type |
|---|---|
title | string |
Returns: InlineTextFormatter
Defined in: inlineBlocks.ts:145
highlight#
▸ highlight(color: TFormatBlockColor): InlineTextFormatter
Parameters:#
| Name | Type |
|---|---|
color | TFormatBlockColor |
Returns: InlineTextFormatter
Defined in: inlineBlocks.ts:170
linkTo#
▸ linkTo(url: string): InlineTextFormatter
Parameters:#
| Name | Type |
|---|---|
url | string |
Returns: InlineTextFormatter
Defined in: inlineBlocks.ts:174
pushToLast#
▸ pushToLast(format: InlineFormat): InlineTextFormatter
Parameters:#
| Name | Type |
|---|---|
format | InlineFormat |
Returns: InlineTextFormatter
Inherited from: HighlightColors
Defined in: inlineBlocks.ts:49