Skip to content

Commit

Permalink
DocGen 23_1 result (#5213)
Browse files Browse the repository at this point in the history
  • Loading branch information
dxrobot authored Jun 19, 2023
1 parent d4d4d40 commit 66fb12e
Show file tree
Hide file tree
Showing 9 changed files with 17 additions and 17 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ type: function(e)
---
---
##### shortDescription
A function that is executed after the UI component's [value](/api-reference/10%20UI%20Components/Editor/1%20Configuration/value.md '{basewidgetpath}/Configuration/#value') is changed.
A function that is executed after the UI component's [value](/api-reference/10%20UI%20Components/dxHtmlEditor/1%20Configuration/value.md '{basewidgetpath}/Configuration/#value') is changed.

##### param(e): ui/html_editor:ValueChangedEvent
Information about the event.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ default: 'html'
---
---
##### shortDescription
Specifies in which markup language the [value](/api-reference/10%20UI%20Components/Editor/1%20Configuration/value.md '/Documentation/ApiReference/UI_Components/dxHtmlEditor/Configuration/#value') is stored.
Specifies in which markup language the [value](/api-reference/10%20UI%20Components/dxHtmlEditor/1%20Configuration/value.md '/Documentation/ApiReference/UI_Components/dxHtmlEditor/Configuration/#value') is stored.

---
Markdown requires the <a href="https://www.npmjs.com/package/turndown" target="_blank">turndown</a> and <a href="https://www.npmjs.com/package/devextreme-showdown" target="_blank">devextreme-showdown</a> libraries. If you use browser scripts, link them before the DevExtreme scripts as shown below:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ type: Union
---
---
##### shortDescription
Specifies in which markup language the [value](/api-reference/10%20UI%20Components/Editor/1%20Configuration/value.md '/Documentation/ApiReference/UI_Components/dxHtmlEditor/Configuration/#value') is stored.
Specifies in which markup language the [value](/api-reference/10%20UI%20Components/dxHtmlEditor/1%20Configuration/value.md '/Documentation/ApiReference/UI_Components/dxHtmlEditor/Configuration/#value') is stored.

---
<!--
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#include tutorials-intro-installationnote

[important] Before you start this tutorial, read the HtmlEditor [Overview](/Documentation/Guide/UI_Components/HtmlEditor/Overview/) guide.
[important] Before you start this tutorial, read the HtmlEditor [Overview](/concepts/05%20UI%20Components/HtmlEditor/05%20Overview.md '/Documentation/Guide/UI_Components/HtmlEditor/Overview/') guide.

This tutorial explains how to add an HtmlEditor to a page and configure its core features. The following control demonstrates the result:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The HtmlEditor can output markup in HTML or Markdown. Use the [valueType](/api-reference/10%20UI%20Components/dxHtmlEditor/1%20Configuration/valueType.md '/Documentation/ApiReference/UI_Components/dxHtmlEditor/Configuration/#valueType') property to define the language. If you use Markdown, add the <a href="https://www.npmjs.com/package/turndown" target="_blank">turndown</a> and <a href="https://www.npmjs.com/package/devextreme-showdown" target="_blank">devextreme-showdown</a> libraries to your project. In this tutorial, HTML is used as the output language.

The control stores the document markup in the [value](/api-reference/10%20UI%20Components/Editor/1%20Configuration/value.md '/Documentation/ApiReference/UI_Components/dxHtmlEditor/Configuration/#value') property. If you use this property to specify the document's initial content, the language should match **valueType**. You can also declare HTML content inside the HtmlEditor element. In this case, the language (HTML) and **valueType** can differ.
The control stores the document markup in the [value](/api-reference/10%20UI%20Components/dxHtmlEditor/1%20Configuration/value.md '/Documentation/ApiReference/UI_Components/dxHtmlEditor/Configuration/#value') property. If you use this property to specify the document's initial content, the language should match **valueType**. You can also declare HTML content inside the HtmlEditor element. In this case, the language (HTML) and **valueType** can differ.

---
##### jQuery
Expand Down
2 changes: 1 addition & 1 deletion concepts/05 UI Components/HtmlEditor/05 Overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ HtmlEditor is a client-side WYSIWYG editor that allows users to format text and

## How to Use HTMLEditor

HtmlEditor is designed to create rich text and export it in HTML or Markdown format. You can also use the component to parse HTML content (for example, if you set [value](/Documentation/ApiReference/UI_Components/dxHtmlEditor/Configuration/#value) to markup). However, this technique may prove ineffective because HtmlEditor does not support all HTML features. The following limitations apply:
HtmlEditor is designed to create rich text and export it in HTML or Markdown format. You can also use the component to parse HTML content (for example, if you set [value](/api-reference/10%20UI%20Components/dxHtmlEditor/1%20Configuration/value.md '/Documentation/ApiReference/UI_Components/dxHtmlEditor/Configuration/#value') to markup). However, this technique may prove ineffective because HtmlEditor does not support all HTML features. The following limitations apply:

- If you use <a href="https://developer.mozilla.org/en-US/docs/Web/API/Web_components/Using_shadow_DOM" target="_blank">Shadow DOM</a>, the HtmlEditor component may experience issues in some browsers (see <a href="https://developer.mozilla.org/en-US/docs/Web/API/ShadowRoot#browser_compatibility" target="_blank">getSelection</a>).

Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
The Popup component always displays a native scrollbar when the height of the Popup's content is greater than that of the Popup.

You can also implement a scrollbar that belongs to the [ScrollView](/Documentation/ApiReference/UI_Components/dxScrollView/) component. This implementation is more flexible. For example, you can enable [right-to-left representation](/Documentation/ApiReference/UI_Components/dxScrollView/Configuration/#rtlEnabled) or scroll the content to a [specific position](/Documentation/ApiReference/UI_Components/dxScrollView/Methods/#scrollTotargetLocation). For more information about the available options, refer to the [ScrollView API section](/Documentation/ApiReference/UI_Components/dxScrollView/).
You can also implement a scrollbar that belongs to the [ScrollView](/api-reference/10%20UI%20Components/dxScrollView '/Documentation/ApiReference/UI_Components/dxScrollView/') component. This implementation is more flexible. For example, you can enable [right-to-left representation](/api-reference/10%20UI%20Components/DOMComponent/1%20Configuration/rtlEnabled.md '/Documentation/ApiReference/UI_Components/dxScrollView/Configuration/#rtlEnabled') or scroll the content to a [specific position](/api-reference/10%20UI%20Components/dxScrollable/3%20Methods/scrollTo(targetLocation).md '/Documentation/ApiReference/UI_Components/dxScrollView/Methods/#scrollTotargetLocation'). For more information about the available options, refer to the [ScrollView API section](/api-reference/10%20UI%20Components/dxScrollView '/Documentation/ApiReference/UI_Components/dxScrollView/').

To implement this solution, follow the steps below:

1. Wrap the content in the ScrollView component and place it in the Popup container.

2. Set the [height](/Documentation/ApiReference/UI_Components/dxScrollView/Configuration/#height) and [width](/Documentation/ApiReference/UI_Components/dxScrollView/Configuration/#width) of the ScrollView to `100%` of the popup content area. To enable this functionality, wrap content into the [ScrollView](/concepts/05%20UI%20Components/ScrollView/00%20Overview.md '/Documentation/Guide/UI_Components/ScrollView/Overview/') component and set its **height** and **width** to 100% of the Popup content area:
2. Set the [height](/api-reference/10%20UI%20Components/DOMComponent/1%20Configuration/height.md '/Documentation/ApiReference/UI_Components/dxScrollView/Configuration/#height') and [width](/api-reference/10%20UI%20Components/DOMComponent/1%20Configuration/width.md '/Documentation/ApiReference/UI_Components/dxScrollView/Configuration/#width') of the ScrollView to `100%` of the popup content area. To enable this functionality, wrap content into the [ScrollView](/concepts/05%20UI%20Components/ScrollView/00%20Overview.md '/Documentation/Guide/UI_Components/ScrollView/Overview/') component and set its **height** and **width** to 100% of the Popup content area:

---
##### jQuery
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Follow the steps below to eliminate possible side effects:

- Disable the [stateStoring](/api-reference/10%20UI%20Components/GridBase/1%20Configuration/stateStoring '/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/stateStoring/') property. Check if the issue still persists. If the issue disappears, it is possible that the saved state is corrupted. Clear the saved state, enable **stateStoring**, and check again.

- FireFox and Safari browsers raise native scrolling events asynchronously. This behavior forces asynchronous row rendering in native scrolling mode even when [renderAsync](/api-reference/10%20UI%20Components/GridBase/1%20Configuration/scrolling/renderAsync.md '/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/scrolling/#renderAsync') is disabled. To avoid this side effect, disable the scrolling.[useNative](/api-reference/10%20UI%20Components/GridBase/1%20Configuration/scrolling/useNative.md '/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/scrolling/#useNative') property. Call the [defaultOptions(rule)](/Documentation/ApiReference/UI_Components/dxDataGrid/Methods/#defaultOptionsrule) method to resolve the issue for all DataGrid components in the application.
- FireFox and Safari browsers raise native scrolling events asynchronously. This behavior forces asynchronous row rendering in native scrolling mode even when [renderAsync](/api-reference/10%20UI%20Components/GridBase/1%20Configuration/scrolling/renderAsync.md '/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/scrolling/#renderAsync') is disabled. To avoid this side effect, disable the scrolling.[useNative](/api-reference/10%20UI%20Components/GridBase/1%20Configuration/scrolling/useNative.md '/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/scrolling/#useNative') property. Call the [defaultOptions(rule)](/api-reference/10%20UI%20Components/DOMComponent/3%20Methods/defaultOptions(rule).md '/Documentation/ApiReference/UI_Components/dxDataGrid/Methods/#defaultOptionsrule') method to resolve the issue for all DataGrid components in the application.

- If you bind DataGrid or TreeList to one DataSource instance, reset the DataSource page index once you destroy the component. DataSource does not reset the index automatically. A new component bound to this DataSource may attempt to display the first data page while DataSource may contain only other data pages. The component displays gray boxes in such case.
Call the DataSource.[pageIndex(newIndex)](/api-reference/30%20Data%20Layer/DataSource/3%20Methods/pageIndex(newIndex).md '/Documentation/ApiReference/Data_Layer/DataSource/Methods/#pageIndexnewIndex') method to reset the page index.
Expand Down Expand Up @@ -34,7 +34,7 @@ Call the DataSource.[pageIndex(newIndex)](/api-reference/30%20Data%20Layer/DataS
}
}

Alternatively, you can use CSS to hide the component. In this case, call the [updateDimensions](/Documentation/ApiReference/UI_Components/dxDataGrid/Methods/#updateDimensions) method.
Alternatively, you can use CSS to hide the component. In this case, call the [updateDimensions](/api-reference/10%20UI%20Components/GridBase/3%20Methods/updateDimensions().md '/Documentation/ApiReference/UI_Components/dxDataGrid/Methods/#updateDimensions') method.

##### Vue

Expand Down Expand Up @@ -66,7 +66,7 @@ Call the DataSource.[pageIndex(newIndex)](/api-reference/30%20Data%20Layer/DataS
}
</script>

Alternatively, you can use CSS to hide the component. In this case, call the [updateDimensions](/Documentation/ApiReference/UI_Components/dxDataGrid/Methods/#updateDimensions) method.
Alternatively, you can use CSS to hide the component. In this case, call the [updateDimensions](/api-reference/10%20UI%20Components/GridBase/3%20Methods/updateDimensions().md '/Documentation/ApiReference/UI_Components/dxDataGrid/Methods/#updateDimensions') method.

##### React

Expand Down Expand Up @@ -98,6 +98,6 @@ Call the DataSource.[pageIndex(newIndex)](/api-reference/30%20Data%20Layer/DataS
}
export default App;

Alternatively, you can use CSS to hide the component. In this case, call the [updateDimensions](/Documentation/ApiReference/UI_Components/dxDataGrid/Methods/#updateDimensions) method.
Alternatively, you can use CSS to hide the component. In this case, call the [updateDimensions](/api-reference/10%20UI%20Components/GridBase/3%20Methods/updateDimensions().md '/Documentation/ApiReference/UI_Components/dxDataGrid/Methods/#updateDimensions') method.

---
10 changes: 5 additions & 5 deletions metadata/syntax-data.json
Original file line number Diff line number Diff line change
Expand Up @@ -17480,11 +17480,6 @@
"dxTextBoxOptions.onValueChanged": {
"vue": "@value-changed"
},
"dxTextEditorButton": {
"angular": "dxo-text-editor-button",
"react": "DxTextEditorButton",
"vue": "DxTextEditorButton"
},
"dxTextEditorOptions.buttons": {
"angular": "dxi-button",
"react": "Button",
Expand Down Expand Up @@ -20837,6 +20832,11 @@
"react": "TargetedAppointmentData",
"vue": "DxTargetedAppointmentData"
},
"textEditorButton": {
"angular": "dxo-text-editor-button",
"react": "TextEditorButton",
"vue": "DxTextEditorButton"
},
"toolbarPreparingInfo.toolbarOptions": {
"vue": "toolbar-options"
},
Expand Down

0 comments on commit 66fb12e

Please sign in to comment.