Skip to content

Commit ef8a9b8

Browse files
998669: UG content and sample corrections
1 parent 31e2f11 commit ef8a9b8

File tree

13 files changed

+58
-62
lines changed

13 files changed

+58
-62
lines changed

blazor/blockeditor/built-in-blocks/built-in-blocks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ layout: post
33
title: Blocks in Blazor Block Editor Component | Syncfusion
44
description: Checkout and learn about Blocks in Syncfusion Blazor Block Editor component and more.
55
platform: Blazor
6-
control: Block Editor
6+
control: BlockEditor
77
documentation: ug
88
---
99

blazor/blockeditor/built-in-blocks/embed.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ layout: post
33
title: Embed in Blazor Block Editor Component | Syncfusion
44
description: Checkout and learn about Embed in Syncfusion Blazor Block Editor component and more.
55
platform: Blazor
6-
control: Block Editor
6+
control: BlockEditor
77
documentation: ug
88
---
99

blazor/blockeditor/built-in-blocks/inline-content.md

Lines changed: 18 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@ layout: post
33
title: Inline content in Blazor Block Editor Component | Syncfusion
44
description: Checkout and learn about Inline content in Syncfusion Blazor Block Editor component and more.
55
platform: Blazor
6-
control: Block Editor
6+
control: BlockEditor
77
documentation: ug
88
---
99

1010
# Inline Content in Blazor Block Editor component
1111

12-
In the Syncfusion Block Editor, all content is organized within blocks. Each block contains a `Content` property, which is an array of inline elements that define the text and functionality within that block.
12+
In the Syncfusion Block Editor, all content is organized within blocks. Each block contains a `Content` property, which is a list of `ContentModel` that defines the text and functionality within that block.
1313

14-
Each inline element in the `Content` array is an object with properties such as `ID`, `ContentType`, `Content`, and `Styles`, allowing for granular control over its appearance and behavior.
14+
Each `ContentModel` is an object with properties such as `ID`, `ContentType`, `Content`, and `Properties`, allowing for granular control over its appearance and behavior.
1515

1616
## Setting content type
1717

@@ -30,7 +30,7 @@ By default, the content type is set to `Text`.
3030

3131
To configure text content, set the `ContentType` property to `Text`. This is the default content type if none is specified.
3232

33-
### Type
33+
### ContentType
3434

3535
```cshtml
3636
// Adding inline text
@@ -43,19 +43,17 @@ To configure text content, set the `ContentType` property to `Text`. This is the
4343

4444
## Configure hyperlink
4545

46-
To create a hyperlink, set the `ContentType` property to `Link`. You can configure the link's URL and target using the `Properties` property.
46+
To create a hyperlink, set the `ContentType` property to `Link`. You can configure the link's URL using the `Properties` property.
4747

4848
### Configure link properties
4949

50-
Link settings control the behavior and properties of hyperlinks in your content. You can configure link settings using the link `Properties` property.
51-
52-
Link settings are configured through the `Properties` property, which accepts the following options:
50+
Link settings control the behavior and properties of hyperlinks in your content. You can configure link settings using the `Properties` property which accepts the following options:
5351

5452
| Property | Description | Default Value |
5553
|----------|-------------|---------------|
5654
| Url | Specifies the destination URL of the link. | `''` |
5755

58-
### Type & Props
56+
### ContentType and Properties
5957

6058
```cshtml
6159
new BlockModel
@@ -65,7 +63,7 @@ Link settings are configured through the `Properties` property, which accepts th
6563
}
6664
```
6765

68-
## Configure Label
66+
## Configure label
6967

7068
To render labels, set the `ContentType` property to `Label`. Specify the `LabelID` of the particular label in `Properties` to render a label.
7169

@@ -78,9 +76,9 @@ The Block Editor comes with different built-in label items. These includes:
7876

7977
### Customize label
8078

81-
You can customize the labels by using the `Properties` property along with contentType `Label`.
79+
You can customize the labels by using the `Properties` property along with `ContentType` as `Label`.
8280

83-
### Type & Props
81+
### ContentType and Properties
8482

8583
```cshtml
8684
// Adding inline label
@@ -101,31 +99,31 @@ Use the `TriggerChar` property to define the character that opens the label sugg
10199

102100
Define the available labels using the `Items` array. When a user types the trigger character, a popup will show matching items.
103101

104-
Each item in the [Items] array supports the following properties:
102+
Each item supports the following properties:
105103

106-
| Property | Description |
107-
| --------------------------------------------------------------------- | --------------------------------------------------- |
104+
| Property | Description |
105+
| -----------------------------| --------------------------------------------------- |
108106
| `ID` | A unique identifier for the label. |
109107
| `Text` | The display text for the label. |
110108
| `GroupBy` | The category name for grouping similar labels. |
111109
| `LabelColor` | The background color of the label. |
112110
| `IconCss` | A CSS class for an icon to display with the label. |
113111

114112

115-
When users type the trigger character followed by text, a popup will appear showing matching label items from which they can select. The selected label will be inserted into the content as a Label content item.
113+
When users type the trigger character, a popup will appear showing matching label items from which they can select. The selected label will be inserted into the content as a Label content item.
116114

117115
### Using labels with group headers
118116

119117
Labels with the same `GroupBy` value will be grouped together in the label selection popup:
120118

121-
The below sample demonstrates the customization of labels in the Block Editor.
122-
123119
## Configure mention
124120

125121
Mentions are references to users or entities that can be inserted into your content. You can configure mention content by setting the type property to `Mention`. Specify the `UserID` of particular user in `Properties` to render a mention.
126122

127123
Mentions are typically triggered by the `@` character and are linked to the `Users` collection defined in the Block Editor.
128124

125+
The below sample demonstrates the usage of Mention and Label types in the Block Editor.
126+
129127
```cshtml
130128
131129
@using Syncfusion.Blazor.BlockEditor
@@ -150,7 +148,7 @@ Mentions are typically triggered by the `@` character and are linked to the `Use
150148
new BlockModel
151149
{
152150
BlockType = BlockType.Paragraph,
153-
Content =[
151+
Content =[
154152
new ContentModel{ContentType = ContentType.Text, Content = "The Block Editor supports various content types: "},
155153
new ContentModel{ContentType = ContentType.Link, Content = "hyperlinks", Properties = new LinkContentSettings { Url = "https://ej2.syncfusion.com/documentation/"} },
156154
new ContentModel{ContentType = ContentType.Text, Content = ", inline "},
@@ -184,7 +182,7 @@ The `Styles` property supports the following options:
184182
| `Subscript` | Renders the text as subscript. | `false` |
185183
| `Uppercase` | Converts the text to uppercase. | `false` |
186184
| `Lowercase` | Converts the text to lowercase. | `false` |
187-
| `InlineCode` | Converts the text to inline code. | `false` |
185+
| `InlineCode` | Converts the text to inline code. | `false` |
188186

189187
You can apply one or more of these styles to any supported content element for rich text formatting.
190188

blazor/blockeditor/built-in-blocks/list-types.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ layout: post
33
title: Lists in Blazor Block Editor Component | Syncfusion
44
description: Checkout and learn about List Blocks in Syncfusion Blazor Block Editor component and more.
55
platform: Blazor
6-
control: Block Editor
6+
control: BlockEditor
77
documentation: ug
88
---
99

@@ -15,7 +15,7 @@ The Syncfusion Blazor Block Editor component uses list blocks to organize conten
1515

1616
You can render a Bullet List block by setting the `BlockType` property to `BulletList`. This block type is used to display unordered lists.
1717

18-
### Type
18+
### BlockType
1919

2020
```cshtml
2121
// Adding bulletlist block
@@ -82,7 +82,7 @@ You can render a Checklist block by setting the `BlockType` property to `Checkli
8282

8383
### Configure checked state
8484

85-
For blocks that support selection states, such as a `Checklist`, you can configure the checked state using the `properties` property with `IsChecked`.
85+
For blocks that support selection states, such as a `Checklist`, you can configure the checked state using the `Properties` property with `IsChecked`.
8686

8787
By default, the `IsChecked` property is set to `false`.
8888

@@ -134,7 +134,7 @@ By default, the `IsChecked` property is set to `false`.
134134

135135
### Configure placeholder
136136

137-
The `Placeholder` property sets the text that appears when the block is empty. The default placeholder for a checklist is `To Do`.
137+
The `Placeholder` property sets the text that appears when the block is empty. The default placeholder for a checklist is `Todo`.
138138

139139
```cshtml
140140
// Adding placeholder value

blazor/blockeditor/built-in-blocks/table-block.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ layout: post
33
title: Table Blocks in Blazor Block Editor Component | Syncfusion
44
description: Checkout and learn about Table Blocks in Syncfusion Blazor Block Editor component and more.
55
platform: Blazor
6-
control: Block Editor
6+
control: BlockEditor
77
documentation: ug
88
---
99

@@ -17,12 +17,12 @@ For Table blocks, you can configure layout and structure using the `Properties`
1717

1818
| Property | Description | Default Value |
1919
|----------|-------------|---------------|
20-
| width | Specifies the display width of the table. | `100%` |
21-
| enableHeader | Specifies whether to enable header for the table. | `true` |
22-
| enableRowNumbers | Specifies whether to enable row numbers for the table. | `true` |
23-
| readOnly | Specifies whether to render the table in read-only mode, disabling edits. | `false` |
24-
| columns | Defines the columns of the table, including their types and headers. | `[]` |
25-
| rows | Defines the rows of the table, each containing cells tied to columns. | `[]` |
20+
| Width | Specifies the display width of the table. | `100%` |
21+
| EnableHeader | Specifies whether to enable header for the table. | `true` |
22+
| EnableRowNumbers | Specifies whether to enable row numbers for the table. | `true` |
23+
| ReadOnly | Specifies whether to render the table in read-only mode, disabling edits. | `false` |
24+
| Columns | Defines the columns of the table, including their types and headers. | `[]` |
25+
| Rows | Defines the rows of the table, each containing cells tied to columns. | `[]` |
2626

2727
The following example demonstrates how to pre-configure a `Table` block in the editor.
2828

blazor/blockeditor/built-in-blocks/typography.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ layout: post
33
title: Typography Blocks in Blazor Block Editor Component | Syncfusion
44
description: Checkout and learn about Typography Blocks in Syncfusion Blazor Block Editor component and more.
55
platform: Blazor
6-
control: Block Editor
6+
control: BlockEditor
77
documentation: ug
88
---
99

@@ -15,7 +15,7 @@ Typography blocks are essential for organizing and presenting text-based content
1515

1616
Paragraph blocks are the most common type, used for standard text content. They serve as the default block type and provide basic text formatting options. To render a Paragraph block, set the `BlockType` property to `Paragraph`.
1717

18-
### Type
18+
### BlockType
1919

2020
```cshtml
2121
// Adding paragraph block
@@ -50,9 +50,9 @@ The below sample demonstrates the configuration of paragraph block in the Block
5050

5151
### Configure placeholder
5252

53-
You can configure placeholder text for block using the `placeholder` property. This text appears when the block is empty. The default placeholder for the paragraph block is `Write something or ‘/’ for commands.`.
53+
You can configure placeholder text for block using the `Placeholder` property. This text appears when the block is empty. The default placeholder for the paragraph block is `Write something or ‘/’ for commands.`.
5454

55-
### Type & Props
55+
### BlockType and Properties
5656

5757
```cshtml
5858
// Adding placeholder
@@ -97,7 +97,7 @@ Heading blocks create document titles and section headers. These blocks help str
9797

9898
Set the heading level using the `Level` property, with `1` being the highest level (title) and `4` being the lowest (subsection).
9999

100-
### Type & Props
100+
### BlockType and Properties
101101

102102
```cshtml
103103
//Adding Heading block
@@ -150,7 +150,7 @@ The following sample demonstrates the configuration of a heading block in the Bl
150150

151151
### Configure placeholder
152152

153-
You can configure placeholder text for block using the `Paceholder` property. This text appears when the block is empty. The default placeholder for heading block is `Heading{levels}`.
153+
You can configure placeholder text for block using the `Placeholder` property. This text appears when the block is empty. The default placeholder for heading block is `Heading{level}`.
154154

155155
```cshtml
156156
//Adding Placeholder value to blocktype
@@ -179,7 +179,7 @@ Child blocks can be configured with all the same properties as top-level blocks.
179179

180180
You can control whether a block is expanded or collapsed using the `IsExpanded` property. By default, this property is set to `false`, meaning the block will be collapsed initially. This setting is only applicable to Collapsible blocks.
181181

182-
### Type & Props
182+
### BlockType and Properties
183183

184184
```cshtml
185185
//Configure collapsibleHeading block
@@ -238,7 +238,7 @@ This example shows how to configure `CollapsibleHeading` and `CollapsibleParagra
238238

239239
### Configure placeholder
240240

241-
You can configure placeholder text for block using the `Placeholder` property. This text appears when the block is empty. The default placeholder for collapsible heading and collapsible paragraph is `Collapsible Heading{levels}` and `Collapsible Paragraph` respectively.
241+
You can configure placeholder text for block using the `Placeholder` property. This text appears when the block is empty. The default placeholder for collapsible heading and collapsible paragraph is `Collapsible Heading{level}` and `Collapsible Paragraph` respectively.
242242

243243
```cshtml
244244
// Adding placeholder value to collapsible heading
@@ -261,7 +261,7 @@ A Divider block inserts a horizontal line to separate content. Render it by sett
261261

262262
This sample shows how to place a divider between two blocks.
263263

264-
``cshtml
264+
```cshtml
265265
@using Syncfusion.Blazor.BlockEditor
266266
267267
<SfBlockEditor Blocks="@BlockData"></SfBlockEditor>
@@ -291,7 +291,7 @@ This sample shows how to place a divider between two blocks.
291291

292292
## Configure quote block
293293

294-
Quote blocks are styled for displaying quotations or excerpts. Render a Quote block by setting the [BlockType] to `Quote`.
294+
Quote blocks are styled for displaying quotations or excerpts. Render a Quote block by setting the `BlockType` to `Quote`.
295295

296296
The following sample shows how to configure a quote block.
297297

@@ -370,7 +370,7 @@ Child blocks can be configured with all the same properties as top-level blocks.
370370

371371
### Configure parent id
372372

373-
The Block Editor supports hierarchical content through the `Children` property, which is available for `Callout` and `Collapsible` blocks. To establish a clear parent-child relationship, the `ParentId` of each child block must match the `ID` of its parent.
373+
The Block Editor supports hierarchical content through the `Children` property, which is available for `Callout` and `Collapsible` blocks. To establish a clear parent-child relationship, the `ParentID` of each child block must match the `ID` of its parent block.
374374

375375
This structure is essential for maintaining nested relationships within the editor. The following sample demonstrates how to create a nested hierarchy.
376376

blazor/blockeditor/editor-menus.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
layout: post
33
title: Editor Menus in Blazor Block Editor Component | Syncfusion
4-
description: Checkout and learn about Editor Menus with Blazor Block Editor component in Blazor WebAssembly App.
4+
description: Checkout and learn about Editor Menus in Syncfusion Blazor Block Editor component and more.
55
platform: Blazor
6-
control: Block Editor
6+
control: BlockEditor
77
documentation: ug
88
---
99

@@ -25,7 +25,7 @@ The Slash Command menu comes with a set of pre-defined commands for all block ty
2525
- **Image**: Inserts a media block for images.
2626
- **Toggle**: Creates a collapsible content block.
2727
- **Callout**: Inserts a block for highlighting important information.
28-
- **Utility (Divider, Quote, Code)**: Inserts a utility block like a divider, quote, or code block.
28+
- **Utility (Divider, Quote)**: Inserts a utility block like a divider or quote block.
2929

3030
### Customize Slash command menu
3131

blazor/blockeditor/events.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
layout: post
33
title: Events in Blazor Block Editor Component | Syncfusion
4-
description: Checkout and learn about Events with Blazor Block Editor component in Blazor WebAssembly App.
4+
description: Checkout and learn about Events in Syncfusion Blazor Block Editor component and more.
55
platform: Blazor
6-
control: Block Editor
6+
control: BlockEditor
77
documentation: ug
88
---
99

blazor/blockeditor/getting-started-wasm-app.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
layout: post
33
title: Getting Started | Syncfusion Block Editor Component | Blazor WASM App
4-
description: Check out and learn here about the documentation for getting started with Blazor Block Editor Component in Blazor WASM App. Explore here to more details.
4+
description: Checkout and learn about the documentation for getting started with Blazor Block Editor Component in Blazor WASM App. Explore here to more details.
55
platform: Blazor
6-
control: Block Editor
6+
control: BlockEditor
77
documentation: ug
88
---
99

blazor/blockeditor/getting-started-web-app.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
layout: post
3-
title: Getting Started with Syncfusion Block Editor Component | Blazor Web App
4-
description: Check out and learn here about the documentation for getting started with Blazor Block Editor Component in Blazor Web App. Explore here to more details.
3+
title: Getting Started | Syncfusion Block Editor Component | Blazor Web App
4+
description: Checkout and learn about the documentation for getting started with Blazor Block Editor Component in Blazor Web App. Explore here to more details.
55
platform: Blazor
6-
control: Block Editor
6+
control: BlockEditor
77
documentation: ug
88
---
99

0 commit comments

Comments
 (0)