Skip to content

Commit 702647d

Browse files
Merge branch 'development' into kv-oidc-login
2 parents e0b2eb9 + 42fb642 commit 702647d

3,033 files changed

Lines changed: 1653 additions & 67837 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-10/pluggable-widgets/_index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ weight: 90
1212
Mendix comes with a wide variety of [Widgets](/refguide/pages/#widgets-categories), but sometimes your app requires a widget outside of this set. To support a more advanced UI pattern or create app-specific interactions, you will need to make your own pluggable widget. This documentation will help you achieve that in Studio Pro 10. See these links for other versions' documentation:
1313

1414
* [Mendix 9](/apidocs-mxsdk/apidocs/pluggable-parent-9/)
15-
* [Mendix 8](/apidocs-mxsdk/apidocs/pluggable-parent-8/)
1615

1716
Your new pluggable widget can be used while modeling pages alongside standard Mendix components. It can also be shared between multiple apps and distributed through the [Marketplace](/appstore/).
1817

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-10/pluggable-widgets/pluggable-widgets-studio-apis.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ weight: 30
1010

1111
This guide explains the APIs offered by Mendix Studio Pro so you can build better pluggable widgets. Specifically, you can use these APIs and modules to alter pluggable widgets' preview appearances while working in Studio Pro's **Design mode**. To learn about creating a custom preview in **Structure mode**, add custom consistency checks, or conditionally hide widget properties, read the [Configuration Module API for Pluggable Widgets](/apidocs-mxsdk/apidocs/pluggable-widgets-config-api-10/).
1212

13-
Lastly, [Client APIs Available to Pluggable Widgets](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis-10/) is meant for pluggable widget development once your app is running in the client. This guide's APIs are available in Mendix 8.0.0 and higher.
13+
Lastly, [Client APIs Available to Pluggable Widgets](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis-10/) is meant for pluggable widget development once your app is running in the client.
1414

1515
## Values API {#values}
1616

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-11/pluggable-widgets/_index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ Mendix comes with a wide variety of [Widgets](/refguide/pages/#widgets-categorie
1313

1414
* [Mendix 10](/apidocs-mxsdk/apidocs/pluggable-widgets-10/)
1515
* [Mendix 9](/apidocs-mxsdk/apidocs/pluggable-parent-9/)
16-
* [Mendix 8](/apidocs-mxsdk/apidocs/pluggable-parent-8/)
1716

1817
Your new pluggable widget can be used while modeling pages alongside standard Mendix components. It can also be shared between multiple apps and distributed through the [Marketplace](/appstore/).
1918

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-11/pluggable-widgets/pluggable-widgets-client-apis/_index.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -485,6 +485,39 @@ if (selection.type === "Single") {
485485

486486
## Exposed Modules
487487

488+
### Session {#session}
489+
490+
The Mendix Platform exposes a `mendix/session` module for inspecting the current user session. It is available in both web and native.
491+
492+
For instance, `getUserId` returns the current user's GUID as a `string`.
493+
494+
```ts
495+
function getUserId(): GUID;
496+
```
497+
498+
---
499+
500+
### Parser {#parser}
501+
502+
The Mendix Platform exposes a `mendix/parser` module that provides locale-aware formatting and parsing of attribute values. These functions use the same locale and formatting settings of the built-in Mendix widgets. It is available in both web and native.
503+
504+
```ts
505+
import { formatValue, parseValue } from "mendix/parser";
506+
```
507+
508+
Both functions accept an optional configuration object:
509+
510+
```ts
511+
interface FormatValueConfig {
512+
selector?: "date" | "time" | "datetime";
513+
datePattern?: string;
514+
places?: number;
515+
groups?: boolean;
516+
}
517+
```
518+
519+
For the reference of the API, you can refer to the [API documentation](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis-parser/).
520+
488521
### Icon {#icon}
489522

490523
Mendix Platform exposes two versions of an `Icon` react component: `mendix/components/web/Icon` and `mendix/components/native/Icon`. Both components are useful helpers to render `WebIcon` and `NativeIcon` values respectively. They should be passed through an `icon` prop. The native `Icon` component additionally accepts `color` (`string`) and `size` (`number`) props.

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-11/pluggable-widgets/pluggable-widgets-client-apis/pluggable-widgets-client-apis-list-values.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -197,6 +197,12 @@ It is possible to set filtering conditions for items of a datasource. `setFilter
197197

198198
Some examples of builder functions are `equals`, `greaterThan`, `lessThanOrEqual` for filtering on `DateTime` or `Decimal` attributes. Functions like `startsWith`, `contains` are useful for filtering on `String` attributes. Filtering based on associations is also possible. For example, you can use `equals` with references and `contains` with reference sets.
199199

200+
To use the filter builders in a pluggable widget, import the individual builder functions you need directly from the "mendix/filters/builders" module path:
201+
202+
```ts
203+
import { attribute, literal, equals, startsWith, and, or } from "mendix/filters/builders";
204+
```
205+
200206
The following code samples show how to use filter builders and apply filtering to a data source property with three linked attributes and two linked associations:
201207

202208
```ts

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-11/pluggable-widgets/pluggable-widgets-property-types.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,13 @@ This defines the prop `key` in the client component props which are supplied to
2828

2929
#### AllowUpload (Optional) {#allow-upload}
3030

31-
This optional attribute applies only to [file](#file) and [image](#image) properties and determines whether users can upload and edit files. When set to the default value of `false`, properties use the legacy read-only behavior. Setting it to `true` unlocks upload and edit capabilities by passing `EditableFileValue<FileValue>` and `EditableImageValue<ImageValue>` types, as props to a client component.
31+
{{% alert color="info" %}}
32+
AllowUpload was introduced in Mendix [11.8](/releasenotes/studio-pro/11.8/). Support for native widgets was introduced in Mendix [11.11](/releasenotes/studio-pro/11.11/).
33+
{{% /alert %}}
3234

33-
{{% alert color="warning" %}} Legacy DynamicValue types for file and image properties are deprecated and will be removed at Mendix 12. Use allowUpload="true" to migrate to the new editable types before Mendix 12. {{% /alert %}}
35+
This optional attribute applies only to [file](#file) and [image](#image) properties and determines whether users can upload and edit files. When set to the default value of `false`, properties use read-only behavior. Setting it to `true` unlocks upload and edit capabilities by passing `EditableFileValue<FileValue>` and `EditableImageValue<ImageValue>` types, as props to a client component.
3436

35-
Be aware of behavioral differences between the legacy read-only mode (`false`) and the new editable mode (`true`).
37+
Be aware of behavioral differences between the read-only mode (`false`) and the editable mode (`true`).
3638

3739
#### Type (Required)
3840

@@ -269,9 +271,7 @@ Then the Studio Pro UI for the component appears like this:
269271

270272
Image allows a user to configure an image from an object that is a specialization of **System.Image**. It is passed as an [`EditableImageValue<ImageValue>`](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis/#editable-image-value) prop to a client component. For more information about supported image formats, see the [Images Reference Guide](/refguide/images/).
271273

272-
The user can use the optional attribute [`allowUpload`](#allow-upload) with default value `false` to use the legacy [`Dynamic<FileValue>`](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis/#filevalue) prop. Beware of behavioral differences based on the `allowUpload` attribute.
273-
274-
{{% alert color="warning" %}} Legacy DynamicValue types for file and image properties are deprecated and will be removed at Mendix 12. Use allowUpload="true" to migrate to the new editable types before Mendix 12. {{% /alert %}}
274+
The user can use the optional attribute [`allowUpload`](#allow-upload) with default value `false` to use the [`Dynamic<FileValue>`](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis/#filevalue) prop. Beware of behavioral differences based on the `allowUpload` attribute.
275275

276276
#### XML Attributes
277277

@@ -710,9 +710,7 @@ Then the Studio Pro UI for the property appears like this:
710710

711711
The file property type allows a user to configure and edit a file from and to an object that is a specialization of **System.File**. It is passed as a [`EditableFileValue<FileValue>`](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis/#editable-file-value) prop to a client component.
712712

713-
The user can use the optional attribute [`allowUpload`](#allow-upload) with default value `false` to use the legacy [`Dynamic<FileValue>`](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis/#filevalue) prop. Beware of behavioral differences based on the `allowUpload` attribute.
714-
715-
{{% alert color="warning" %}} Legacy DynamicValue types for file and image properties are deprecated and will be removed at Mendix 12. Use allowUpload="true" to migrate to the new editable types before Mendix 12. {{% /alert %}}
713+
The user can use the optional attribute [`allowUpload`](#allow-upload) with default value `false` to use the [`Dynamic<FileValue>`](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis/#filevalue) prop. Beware of behavioral differences based on the `allowUpload` attribute.
716714

717715
#### XML Attributes
718716

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-11/pluggable-widgets/pluggable-widgets-studio-apis.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ aliases:
1212

1313
This guide explains the APIs offered by Mendix Studio Pro so you can build better pluggable widgets. Specifically, you can use these APIs and modules to alter pluggable widgets' preview appearances while working in Studio Pro's **Design mode**. To learn about creating a custom preview in **Structure mode**, add custom consistency checks, or conditionally hide widget properties, read the [Configuration Module API for Pluggable Widgets](/apidocs-mxsdk/apidocs/pluggable-widgets-config-api/).
1414

15-
Lastly, [Client APIs Available to Pluggable Widgets](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis/) is meant for pluggable widget development once your app is running in the client. This guide's APIs are available in Mendix 8.0.0 and higher.
15+
Lastly, [Client APIs Available to Pluggable Widgets](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis/) is meant for pluggable widget development once your app is running in the client.
1616

1717
## Values API {#values}
1818

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-8/_index.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-8/pluggable-widgets/_index.md

Lines changed: 0 additions & 10 deletions
This file was deleted.

0 commit comments

Comments
 (0)