Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[dev] update docusaurus from 3.3.2 to 3.5.2 #14

Merged
merged 3 commits into from
Aug 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/grid/api/api_gridcolumn_properties.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,8 @@ columns:[
</tr>
<tr>
<td><b id="header">header</b></td>
<td>(required) an array of objects with header rows configuration. Each header object may include:<ul><li><b>text</b> - (optional) the text of a header</li><li><b>tooltip</b> - (optional) enables/disables the header tooltip, or sets the configuration object with the tooltip settings; <i>true</i> by default. When set as an object, the <b>tooltip</b> config can have the following properties:<ul><li><b>force</b> - (optional) forces opening of a tooltip; if set to true, the <b>showDelay</b> and <b>hideDelay</b> settings are ignored, *false* by default</li><li><b>showDelay</b> - (optional) the time period that should pass before showing a tooltip, in ms</li><li><b>hideDelay</b> - (optional) the time period that should pass before hiding a tooltip, in ms</li><li><b>margin</b> - (optional) the margin between the node and tooltip; *8px* by default</li><li><b>position</b> - (optional) the position of a tooltip: *"right"*, *"bottom"*, *"center"*, *"left"*, *"top"*; *"bottom"* by default</li><li><b>css</b> - (optional) the style of a tooltip box</li></ul></li><li><b>tooltipTemplate</b> - (optional) sets a template for the header tooltip. Takes into account the <a href="../../configuration#html-content-of-grid-columns">htmlEnable</a> property. Return <i>false</i> to disable the tooltip</li><li><a href="../../configuration#alignment"><b>align</b></a> - (optional) aligns data in the header: *"left"* | *"center"* | *"right"*, <i>"left"</i> by default</li><li><b>colspan</b> - (optional) the number of columns in a colspan</li><li><b>rowspan</b> - (optional) the number of rows in a rowspan </li><li><b>css</b> - (optional) styling to be applied to a header</li><li><a href="../../configuration#headerfooter-filters"><b>content</b></a> - (optional) additional content of a header, which can be:<ul><li> a filter: *"inputFilter"* | *"selectFilter"* | *"comboFilter"*</li><li> one of the methods that process values in a column and show result in the header: *"avg"* | *"sum"* | *"max"* | *"min"* | *"count"*</li></ul></li><li><a href="../../configuration#headerfooter-filters"><b>filterConfig</b></a> - (optional) a configuration object for "comboFilter". It can contain a set of properties:<ul><li><b>filter</b> - (optional) sets a custom function for filtering Combo Box options</li><li> <b>multiselection</b> - (optional) enables selection of multiple options</li><li><b>readonly</b> - (optional) makes ComboBox readonly (it is only possible to select options from the list, without entering words in the input)</li><li><b>placeholder</b> - (optional) sets a placeholder in the input of ComboBox</li><li><b>virtual</b> - (optional) enables dynamic loading of data on scrolling the list of options</li><li><b>template</b> - (optional) a function which returns a template with content for the filter options. Takes an option item as a parameter:<ul><li><b>item</b> - (object) an option item</li></ul></li></ul></li><li><a href="../../configuration#customizing-headerfooter-filters"><b>customFilter</b></a> - (optional) a custom function for extended filtering. It takes two parameters:<ul><li><b>item</b> - (required) a data item the value of which should be compared</li><li> <b>input</b> - (required) the value of the option selected in the filter</li></ul>and returns <i>true/false</i> to specify whether the data item should be displayed in the grid after filtering</li><li><b>headerSort</b> - (optional) enables/disables sorting by clicking the header, <i>true</i> by default</li><li><b>sortAs</b> - (optional) a function that defines the type to sort data as (e.g. string, number, date, etc.)</li><li><b>htmlEnable</b> - (optional) <i>false</i> by default. If set to <i>true</i>, specifies the HTML content (inner HTML) of a header. If set to <i>false</i>, the content of the header cells will be displayed as a <i>string</i> value</li></ul><br><b>Related Sample: </b><a href="https://snippet.dhtmlx.com/eol76o68" target="_blank">Grid. Grouped headers (spans)</a></td>
<td>(required) an array of objects with header rows configuration. Each header object may include:<ul><li><b>text</b> - (optional) the text of a header</li><li><b>tooltip</b> - (optional) enables/disables the header tooltip, or sets the configuration object with the tooltip settings; <i>true</i> by default. When set as an object, the <b>tooltip</b> config can have the following properties:<ul><li><b>force</b> - (optional) forces opening of a tooltip; if set to true, the <b>showDelay</b> and <b>hideDelay</b> settings are ignored, *false* by default</li><li><b>showDelay</b> - (optional) the time period that should pass before showing a tooltip, in ms</li><li><b>hideDelay</b> - (optional) the time period that should pass before hiding a tooltip, in ms</li><li><b>margin</b> - (optional) the margin between the node and tooltip; *8px* by default</li><li><b>position</b> - (optional) the position of a tooltip: *"right"*, *"bottom"*, *"center"*, *"left"*, *"top"*; *"bottom"* by default</li><li><b>css</b> - (optional) the style of a tooltip box</li></ul></li><li><b>tooltipTemplate</b> - (optional) sets a template for the header tooltip. Takes into account the <a href="../../configuration#html-content-of-grid-columns">htmlEnable</a> property. Return <i>false</i> to disable the tooltip</li><li><a href="../../configuration#alignment"><b>align</b></a> - (optional) aligns data in the header: *"left"* | *"center"* | *"right"*, <i>"left"</i> by default</li><li><b>colspan</b> - (optional) the number of columns in a colspan</li><li><b>rowspan</b> - (optional) the number of rows in a rowspan </li><li><b>css</b> - (optional) styling to be applied to a header</li><li><a href="../../configuration#headerfooter-filters"><b>content</b></a> - (optional) additional content of a header, which can be:<ul><li> a filter: *"inputFilter"* | *"selectFilter"* | *"comboFilter"*</li><li> one of the methods that process values in a column and show result in the header: *"avg"* | *"sum"* | *"max"* | *"min"* | *"count"*</li></ul></li><li><a href="../../configuration#headerfooter-filters"><b>filterConfig</b></a> - (optional) a configuration object for <b>"comboFilter"</b>. It can contain a set of properties:<ul><li><b>filter</b> - (optional) sets a custom function for filtering Combo Box options</li><li> <b>multiselection</b> - (optional) enables selection of multiple options</li>
<li><b>readonly</b> - (optional) makes ComboBox readonly (it is only possible to select options from the list, without entering words in the input). The default value of the <b>readonly</b> property depends on the following conditions:<ul><li>the `readonly:true` is set as a default value, if `htmlEnable:true` is set for a column and there is no template specified for a column</li><li>in all other cases, `readonly:false` is set by default</li></ul></li><li><b>placeholder</b> - (optional) sets a placeholder in the input of ComboBox</li><li><b>virtual</b> - (optional) enables dynamic loading of data on scrolling the list of options</li><li><b>template</b> - (optional) a function which returns a template with content for the filter options. Takes an option item as a parameter:<ul><li><b>item</b> - (object) an option item</li></ul></li></ul></li><li><a href="../../configuration#customizing-headerfooter-filters"><b>customFilter</b></a> - (optional) a custom function for extended filtering. It takes two parameters:<ul><li><b>item</b> - (required) a data item the value of which should be compared</li><li> <b>input</b> - (required) the value of the option selected in the filter</li></ul>and returns <i>true/false</i> to specify whether the data item should be displayed in the grid after filtering</li><li><b>headerSort</b> - (optional) enables/disables sorting by clicking the header, <i>true</i> by default</li><li><b>sortAs</b> - (optional) a function that defines the type to sort data as (e.g. string, number, date, etc.)</li><li><b>htmlEnable</b> - (optional) <i>false</i> by default. If set to <i>true</i>, specifies the HTML content (inner HTML) of a header. If set to <i>false</i>, the content of the header cells will be displayed as a <i>string</i> value</li></ul><br><b>Related Sample: </b><a href="https://snippet.dhtmlx.com/eol76o68" target="_blank">Grid. Grouped headers (spans)</a></td>
</tr>
<tr>
<td><b>footer</b></td>
Expand Down
37 changes: 8 additions & 29 deletions docs/grid/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -1020,35 +1020,14 @@ const grid = new dhx.Grid("grid_container", {

### The list of configuration properties for comboFilter

<table>
<tbody>
<tr>
<td><b>filter</b></td>
<td>(<i>function</i>) sets a custom function for filtering Combo Box options</td>
</tr>
<tr>
<td><b>multiselection</b></td>
<td>(<i>boolean</i>) enables selection of multiple options</td>
</tr>
<tr>
<td><b>readonly</b></td>
<td>(<i>boolean</i>) makes ComboBox readonly (it is only possible to select options from the list, without entering words in the input)</td>
</tr>
<tr>
<td><b>placeholder</b></td>
<td>(<i>string</i>) sets a placeholder in the input of ComboBox</td>
</tr>
<tr>
<td><b>virtual</b></td>
<td>(<i>boolean</i>) enables dynamic loading of data on scrolling the list of options</td>
</tr>
<tr>
<td><b>template</b></td>
<td>(<i>function</i>) a function which returns a template with content for the filter options. Takes an option item as a parameter</td>
</tr>
</tbody>
</table>
<br/>
- **filter** - (*function*) sets a custom function for filtering Combo Box options
- **multiselection** - (*boolean*) enables selection of multiple options
- **readonly** - (*boolean*) makes ComboBox readonly (it is only possible to select options from the list, without entering words in the input). The default value of the **readonly** property depends on the following conditions:
- the `readonly:true` is set as a default value, if `htmlEnable:true` is set for a column and there is no template specified for a column
- in all other cases, `readonly:false` is set by default
- **placeholder** - (*string*) sets a placeholder in the input of ComboBox
- **virtual** - (*boolean*) enables dynamic loading of data on scrolling the list of options
- **template** - (*function*) a function which returns a template with content for the filter options. Takes an option item as a parameter

### Customizing header/footer filters

Expand Down
19 changes: 19 additions & 0 deletions docs/whatsnew.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,25 @@ description: You can explore what's new in DHTMLX Suite and its release history

Before updating DHTMLX to the latest version, please check the [Migration to Newer Versions](migration.md) guide to avoid possible breakdowns.

Version 8.4.2
------------------

Released on August 29, 2024

### Fixes

- Core. Destruction of Layout in the Optimus framework causes an error
- Form. A number input with the predefined minimal value fails validation in case the input is empty
- Grid/TreeGrid. Incorrect work of the `comboFilter` input in case entering of HTML content is enabled
- Grid/TreeGrid. Input of a number starting with a decimal point
- Grid/TreeGrid. The use of `autoHeight` and `autoEmptyRow` configs prevents appearing of a new empty row
- Grid/TreeGrid. The `adjust:data` config is applied incorrectly during drag-n-drop
- Grid/TreeGrid. The `adjust` config of the component takes priority over the `adjust` config of a column
- Grid/TreeGrid. Parsing data with the `footerAutoHeight: true` config causes a console error
- Grid/TreeGrid. Dragging adjacent cells from the same column changes their positions relative to each other
- Layout. Issue with cells resizing
- Tree. The intermediate state of three-state checkboxes isn't displayed when a dataset is specified in the Tree configuration

Version 8.4.1
------------------

Expand Down
8 changes: 4 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@
"normalizeLink": "cd plugins && node samplesLinksNormalize.js"
},
"dependencies": {
"@docusaurus/core": "^3.3.2",
"@docusaurus/preset-classic": "^3.3.2",
"@docusaurus/core": "^3.5.2",
"@docusaurus/preset-classic": "^3.5.2",
"@mdx-js/react": "^3.0.0",
"clsx": "^1.1.1",
"docusaurus-gtm-plugin": "^0.0.2",
Expand All @@ -36,8 +36,8 @@
]
},
"devDependencies": {
"@docusaurus/module-type-aliases": "3.0.0",
"@docusaurus/types": "3.0.0",
"@docusaurus/module-type-aliases": "^3.5.2",
"@docusaurus/types": "^3.5.2",
"dhx-md-data-parser": "file:local_modules/dhx-md-data-parser",
"docusaurus-plugin-sass": "^0.2.5",
"webpack-cli": "^4.4.0"
Expand Down
Loading
Loading