Skip to content

DropDownEditors: Add fieldAddons descriptions & code snippets #7978

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: 25_2
Choose a base branch
from
Open

DropDownEditors: Add fieldAddons descriptions & code snippets #7978

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
100 changes: 97 additions & 3 deletions api-reference/10 UI Components/dxDropDownEditor/1 Configuration/fieldAddons.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,105 @@
---
id: dxDropDownEditor.Options.fieldAddons
type: FieldAddons
default: null
default:
inheritsType: FieldAddons
---
---
##### shortDescription
<!-- Description goes here -->
Specifies {WidgetName} input field addons.

---
Field addons are custom markup containers that you can add to either side of the {WidgetName} input field. The component arranges visual elements in the following order: [beforeTemplate]({basewidgetpath}/Configuration/fieldAddons/#beforeTemplate), {WidgetName} input, [afterTemplate]({basewidgetpath}/Configuration/fieldAddons/#afterTemplate).

---

##### jQuery

<!-- tab: index.js -->
$('#{widget-name}-container').dx{WidgetName}({
fieldAddons: {
beforeTemplate(data, element) {
element.append(
$('<i>').addClass('dx-icon-chevronprev'),
);
},
afterTemplate(data, element) {
element.append(
$('<i>').addClass('dx-icon-chevronnext'),
);
},
},
})

##### Angular

<!-- tab: app.component.html -->
<dx-{widget-name}
[fieldAddons]="fieldAddons"
>
<dxo-{widget-name}-field-addons
beforeTemplate="before{WidgetName}"
afterTemplate="after{WidgetName}"
></dxo-{widget-name}-field-addons>
<div *dxTemplate="let data of 'before{WidgetName}'">
<i class="dx-icon-chevronprev"></i>
</div>
<div *dxTemplate="let data of 'after{WidgetName}'">
<i class="dx-icon-chevronnext"></i>
</div>
</dx-{widget-name}>

##### Vue

<!-- tab: App.vue -->
<script setup lang="ts">
import { Dx{WidgetName}, DxFieldAddons } from 'devextreme-vue/{widget-name}';

</script>

<template>
<Dx{WidgetName}
:field-addons="fieldAddons"
>
<DxFieldAddons
before-template="before{WidgetName}"
after-template="after{WidgetName}"
/>
<template #before{WidgetName}="{ data }">
<i class="dx-icon-chevronprev"></i>
</template>
<template #after="{ data }">
<i class="dx-icon-chevronnext"></i>
</template>
</Dx{WidgetName}>
</template>

##### React

<!-- tab: App.tsx -->
import { {WidgetName}, FieldAddons } from 'devextreme-react/{widget-name}';

function before{WidgetName}Render(data) {
return (
<i class="dx-icon-chevronprev"></i>
);
}

function after{WidgetName}Render(data) {
return (
<i class="dx-icon-chevronnext"></i>
);
}

function App() {
return (
<{WidgetName}>
<FieldAddons
beforeRender={before{WidgetName}Render}
afterRender={after{WidgetName}Render}
/>
</{WidgetName}>
);
}

---
<!-- Description goes here -->
100 changes: 97 additions & 3 deletions api-reference/10 UI Components/dxSelectBox/1 Configuration/fieldAddons.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,105 @@
---
id: dxSelectBox.Options.fieldAddons
type: FieldAddons
default: null
default:
inheritsType: FieldAddons
---
---
##### shortDescription
<!-- Description goes here -->
Specifies {WidgetName} input field addons.

---
Field addons are custom markup containers that you can add to either side of the {WidgetName} input field. The component arranges visual elements in the following order: [beforeTemplate]({basewidgetpath}/Configuration/fieldAddons/#beforeTemplate), {WidgetName} input, [afterTemplate]({basewidgetpath}/Configuration/fieldAddons/#afterTemplate).

---

##### jQuery

<!-- tab: index.js -->
$('#{widget-name}-container').dx{WidgetName}({
fieldAddons: {
beforeTemplate(data, element) {
element.append(
$('<i>').addClass('dx-icon-chevronprev'),
);
},
afterTemplate(data, element) {
element.append(
$('<i>').addClass('dx-icon-chevronnext'),
);
},
},
})

##### Angular

<!-- tab: app.component.html -->
<dx-{widget-name}
[fieldAddons]="fieldAddons"
>
<dxo-{widget-name}-field-addons
beforeTemplate="before{WidgetName}"
afterTemplate="after{WidgetName}"
></dxo-{widget-name}-field-addons>
<div *dxTemplate="let data of 'before{WidgetName}'">
<i class="dx-icon-chevronprev"></i>
</div>
<div *dxTemplate="let data of 'after{WidgetName}'">
<i class="dx-icon-chevronnext"></i>
</div>
</dx-{widget-name}>

##### Vue

<!-- tab: App.vue -->
<script setup lang="ts">
import { Dx{WidgetName}, DxFieldAddons } from 'devextreme-vue/{widget-name}';

</script>

<template>
<Dx{WidgetName}
:field-addons="fieldAddons"
>
<DxFieldAddons
before-template="before{WidgetName}"
after-template="after{WidgetName}"
/>
<template #before{WidgetName}="{ data }">
<i class="dx-icon-chevronprev"></i>
</template>
<template #after="{ data }">
<i class="dx-icon-chevronnext"></i>
</template>
</Dx{WidgetName}>
</template>

##### React

<!-- tab: App.tsx -->
import { {WidgetName}, FieldAddons } from 'devextreme-react/{widget-name}';

function before{WidgetName}Render(data) {
return (
<i class="dx-icon-chevronprev"></i>
);
}

function after{WidgetName}Render(data) {
return (
<i class="dx-icon-chevronnext"></i>
);
}

function App() {
return (
<{WidgetName}>
<FieldAddons
beforeRender={before{WidgetName}Render}
afterRender={after{WidgetName}Render}
/>
</{WidgetName}>
);
}

---
<!-- Description goes here -->
9 changes: 4 additions & 5 deletions api-reference/40 Common Types/FieldAddons/afterTemplate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,15 @@ type: template
---
---
##### shortDescription
<!-- Description goes here -->
Specifies custom markup on the right of editor input fields.

##### param(data): Object
<!-- Description goes here -->
Data of the selected editor item.

##### param(element): DxElement
<!-- Description goes here -->
#include common-ref-elementparam with { element: "**afterTemplate**" }

##### return: String | Element | jQuery
<!-- Description goes here -->
A template name or container.

---
<!-- Description goes here -->
9 changes: 4 additions & 5 deletions api-reference/40 Common Types/FieldAddons/beforeTemplate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,15 @@ type: template
---
---
##### shortDescription
<!-- Description goes here -->
Specifies custom markup on the left of editor input fields.

##### param(data): Object
<!-- Description goes here -->
Data of the selected editor item.

##### param(element): DxElement
<!-- Description goes here -->
#include common-ref-elementparam with { element: "**beforeTemplate**" }

##### return: String | Element | jQuery
<!-- Description goes here -->
A template name or container.

---
<!-- Description goes here -->
Loading