JavaScript/jQuery CardView Types

CardClickEvent

The argument type in the cardClick event.

import { CardClickEvent } from "devextreme/ui/card_view"
Type:

Object

CardCover

Configures the card cover.

import { CardCover } from "devextreme/ui/card_view"
Type:

Object

CardDblClickEvent

The argument type in the cardDblClick event.

import { CardDblClickEvent } from "devextreme/ui/card_view"
Type:

Object

CardHeader

Configures the card header.

import { CardHeader } from "devextreme/ui/card_view"
Type:

Object

CardHeaderItem

Configures card header items.

import { CardHeaderItem } from "devextreme/ui/card_view"

You can reuse default items and include custom items.

CardHeaderPredefinedItem

Specifies predefined items for the CardView card headers.

Accepted Values: 'selectionCheckBox' | 'updateButton' | 'deleteButton'

CardHoverChangedEvent

The argument type in the cardHoverChanged event.

import { CardHoverChangedEvent } from "devextreme/ui/card_view"
Type:

Object

CardInfo

The information about the card.

import { CardInfo } from "devextreme/ui/card_view"
Type:

Object

CardInsertedEvent

The argument type in the cardInserted event.

import { CardInsertedEvent } from "devextreme/ui/card_view"
Type:

Object

CardInsertingEvent

The argument type in the cardInserting event.

import { CardInsertingEvent } from "devextreme/ui/card_view"
Type:

Object

CardPreparedEvent

The argument type in the cardPrepared event.

import { CardPreparedEvent } from "devextreme/ui/card_view"
Type:

Object

CardRemovedEvent

The argument type in the cardRemoved event.

import { CardRemovedEvent } from "devextreme/ui/card_view"
Type:

Object

CardRemovingEvent

The argument type in the cardRemoving event.

import { CardRemovingEvent } from "devextreme/ui/card_view"
Type:

Object

CardSavedEvent

The argument type in the cardSaved event.

import { CardSavedEvent } from "devextreme/ui/card_view"
Type:

Object

CardSavingEvent

The argument type in the cardSaving event.

import { CardSavingEvent } from "devextreme/ui/card_view"
Type:

Object

CardTemplateData

Specifies card template data.

import { CardTemplateData } from "devextreme/ui/card_view"
Type:

Object

CardUpdatedEvent

The argument type in the cardUpdated event.

import { CardUpdatedEvent } from "devextreme/ui/card_view"
Type:

Object

CardUpdatingEvent

The argument type in the cardUpdating event.

import { CardUpdatingEvent } from "devextreme/ui/card_view"
Type:

Object

Column

Configures the column.

import { Column } from "devextreme/ui/card_view"
Type:

Object

ColumnProperties

Configures column properties.

import { ColumnProperties } from "devextreme/ui/card_view"
Type:

Object

ColumnTemplateData

The data of column template.

import { ColumnTemplateData } from "devextreme/ui/card_view"
Type:

Object

ContextMenuPreparingEvent

The argument type in the contextMenuPreparing event.

import { ContextMenuPreparingEvent } from "devextreme/ui/card_view"
Type:

Object

ContextMenuTarget

Specifies the element that should be clicked to invoke the context menu.

Accepted Values: 'toolbar' | 'headerPanel' | 'content'

dxCardViewEditing

Configures editing.

import { Editing } from "devextreme/ui/card_view"
Type:

Object

The UI component can allow a user to add, update and delete data. To control which of these operations are allowed, use the allowAdding, allowUpdating and allowDeleting properties.

NOTE
Before allowing a user to add, update, and delete, make sure that your data source supports these actions.

View Demo

dxCardViewFieldInfo

Information about the field.

import { FieldInfo } from "devextreme/ui/card_view"
Type:

Object

EditCanceledEvent

The argument type in the editCanceled event.

import { EditCanceledEvent } from "devextreme/ui/card_view"
Type:

Object

EditCancelingEvent

The argument type in the editCanceling event.

import { EditCancelingEvent } from "devextreme/ui/card_view"
Type:

Object

EditingStartEvent

The argument type in the editingStart event.

import { EditingStartEvent } from "devextreme/ui/card_view"
Type:

Object

EditingTexts

The texts displayed when editing a card.

import { EditingTexts } from "devextreme/ui/card_view"
Type:

Object

FieldCaptionClickEvent

The argument type in the fieldCaptionClick event.

import { FieldCaptionClickEvent } from "devextreme/ui/card_view"
Type:

Object

FieldCaptionDblClickEvent

The argument type in the fieldCaptionDblClick event.

import { FieldCaptionDblClickEvent } from "devextreme/ui/card_view"
Type:

Object

FieldCaptionPreparedEvent

The argument type in the fieldCaptionPrepared event.

import { FieldCaptionPreparedEvent } from "devextreme/ui/card_view"
Type:

Object

FieldTemplateData

Specifies a custom template for the field.

import { FieldTemplateData } from "devextreme/ui/card_view"
Type:

Object

FieldValueClickEvent

The argument type in the fieldValueClick event.

import { FieldValueClickEvent } from "devextreme/ui/card_view"
Type:

Object

FieldValueDblClickEvent

The argument type in the fieldValueDblClick event.

import { FieldValueDblClickEvent } from "devextreme/ui/card_view"
Type:

Object

FieldValuePreparedEvent

The argument type in the fieldValuePrepared event.

import { FieldValuePreparedEvent } from "devextreme/ui/card_view"
Type:

Object

FocusedCardChanged

The argument type in the focusedCardChanged event.

import { FocusedCardChanged } from "devextreme/ui/card_view"
Type:

Object

HeaderPanel

Configures the header panel.

import { HeaderPanel } from "devextreme/ui/card_view"
Type:

Object

InitNewCardEvent

The argument type in the initNewCard event.

import { InitNewCardEvent } from "devextreme/ui/card_view"
Type:

Object

Paging

Configures paging.

import { Paging } from "devextreme/ui/card_view"
Type:

Object

Paging allows the UI component to load data in portions instead of loading it simultaneously. To enable paging, set the paging.enabled property to true.

Users can switch between pages and change paging settings using the pager or they can scroll the pages. Paging settings apply with any scrolling mode.

PredefinedToolbarItem

Specifies predefined items for the CardView toolbar.

Accepted Values: 'columnChooserButton' | 'searchPanel' | 'addCardButton' | 'selectAllButton' | 'clearSelectionButton'

RemoteOperations

Notifies CardView of the server's data processing operations.

import { RemoteOperations } from "devextreme/ui/card_view"
Type:

Object

Server-side data processing improves the UI component's performance on large datasets. When the server does not implement particular operations (and/or the corresponding remoteOperations fields are false) they are executed on the client. Note that the UI component may send queries to the server while executing a client-side operation.

NOTE
Paging, filtering, and sorting are performed on the server for the ODataStore, but you can change them to the client side by setting the corresponding remoteOperations fields to false. Other operations are always client-side.

SelectionChangedEvent

The argument type in the selectionChanged event.

import { SelectionChangedEvent } from "devextreme/ui/card_view"
Type:

Object

SelectionConfiguration

Configures runtime selection.

Name Description
allowSelectAll

Allows users to simultaneously select all or current page cards (depending on selectAllMode).

mode

Specifies the selection mode.

selectAllMode

Specifies the mode for selecting cards. Applies only if selection.allowSelectAll is true.

showCheckBoxesMode

Specifies when to display card selection checkboxes.

import { SelectionConfiguration } from "devextreme/ui/card_view"
Type:

Object

A user can select rows in a single or multiple mode. In multiple mode, a user can select all rows at once. To disable this feature, assign false to the allowSelectAll property.

View Demo

See Also

Toolbar

Configures the toolbar.

import { Toolbar } from "devextreme/ui/card_view"
Type:

Object

ToolbarItem

Configures toolbar items.

import { ToolbarItem } from "devextreme/ui/card_view"

The toolbar can contain the following elements as items:

  • Predefined controls
    Predefined controls appear on the toolbar depending on whether a specific CardView feature is enabled. The following table illustrates the dependency:

    Control Name Image Prerequisites
    addCardButton DevExtreme CardView toolbar addCardButton editing.allowAdding is true
    columnChooserButton DevExtreme CardView toolbar columnChooserButton columnChooser.enabled is true
    searchPanel DevExtreme CardView toolbar searchPanel searchPanel.visible is true
    selectAllButton DevExtreme CardView toolbar selectAllButton selection.allowSelectAll is true and selection.mode is 'multiple'
    clearSelectionButton DevExtreme CardView toolbar clearSelectionButton selection.mode is 'single' or 'multiple'

    If you need to customize a predefined control, add an object to the items[] array. This object must contain the control's name and properties that you want to customize. If a control does not need customization, simply include its name in the toolbar.items[] array.

    The example below customizes the Column Chooser button, adds an Add Card button, and enables the corresponding CardView features:

    jQuery
    index.js
    $(function(){
        $("#CardViewContainer").dxCardView({
            // ...
            editing: {
                allowAdding: true
            },
            columnChooser: {
                enabled: true
            },
            toolbar: {
                items: [ "addCardButton", {
                    name: "columnChooserButton",      
                    locateInMenu: "auto",
                    location: "after"
                }]  
            }
        });
    });
    Angular
    app.component.html
    app.module.ts
    <dx-card-view ... >
        <dxo-editing [allowAdding]="true"></dxo-editing>
        <dxo-column-chooser [enabled]="true"></dxo-column-chooser>
        <dxo-toolbar>
            <dxi-item name="addCardButton"></dxi-item>
            <dxi-item 
                name="columnChooserButton"
                locateInMenu="auto"
                location="after">
            </dxi-item>
        </dxo-toolbar>
    </dx-card-view>
    import { BrowserModule } from '@angular/platform-browser';
    import { NgModule } from '@angular/core';
    import { AppComponent } from './app.component';
    
    import { DxCardViewModule } from 'devextreme-angular';
    
    @NgModule({
        declarations: [
            AppComponent
        ],
        imports: [
            BrowserModule,
            DxCardViewModule,
        ],
        providers: [ ],
        bootstrap: [AppComponent]
    })
    export class AppModule { }
    Vue
    App.vue
    <template>
        <DxCardView ... >
            <DxEditing :allow-adding="true" />
            <DxColumnChooser :enabled="true"/>
            <DxToolbar>
                <DxItem name="addCardButton" />
                <DxItem
                    name="columnChooserButton"
                    locate-in-menu="auto"
                    location="after"
                />
            </DxToolbar>
        </DxCardView>
    </template>
    <script setup lang="ts">
    import { DxCardView, DxEditing, DxColumnChooser, DxToolbar, DxItem } from 'devextreme-vue/card-view';
    </script>
    React
    App.js
    import CardView, { Editing, Toolbar, Item, ColumnChooser } from 'devextreme-react/card-view';
    // ...
    function App() {
        return (
            <CardView ... >
                <Editing allowAdding={true} />
                <ColumnChooser enabled={true} />
                <Toolbar>
                    <Item name="addCardButton" />
                    <Item
                        name="columnChooserButton"
                        locateInMenu="auto"
                        location="after"
                    />
                </Toolbar>
            </CardView>
        );
    }
    IMPORTANT
    CardView does not display controls missing from the items[] array. Ensure that this array includes controls for all enabled features.
  • DevExtreme components

    jQuery

    You can use DevExtreme components as toolbar items. Set the widget property to specify the component that you want to use and configure the component's options:

    index.js
    $(function(){
        $("#CardViewContainer").dxCardView({
            // ...
            toolbar: {
                items: [{
                    widget: "dxSelectBox",
                    options: {
                        // SelectBox properties are specified here
                    }
                }]  
            }
        });
    });
    Angular

    You can use DevExtreme components as toolbar items. Declare a dxi-item element to add a supported component:

    app.component.html
    app.module.ts
    <dx-card-view ... >
        <dxo-card-view-toolbar>
            <dxi-card-view-toolbar-item>
                <dx-select-box>
                    <!-- SelectBox properties are specified here -->
                </dx-select-box>
            </dxi-card-view-toolbar-item>
        </dxo-card-view-toolbar>
    </dx-card-view>
    import { BrowserModule } from '@angular/platform-browser';
    import { NgModule } from '@angular/core';
    import { AppComponent } from './app.component';
    
    import { DxCardViewModule, DxSelectBoxModule } from 'devextreme-angular';
    
    @NgModule({
        declarations: [
            AppComponent
        ],
        imports: [
            BrowserModule,
            DxCardViewModule,
            DxSelectBoxModule,
        ],
        providers: [ ],
        bootstrap: [AppComponent]
    })
    export class AppModule { }
    Vue

    You can use DevExtreme components as toolbar items. Declare a DxItem element to add a supported component:

    App.vue
    <template>
        <DxCardView ... >
            <DxToolbar>
                <DxItem>
                    <DxSelectBox>
                        <!-- SelectBox properties are specified here -->
                    </DxSelectBox>
                </DxItem>
            </DxToolbar>
        </DxCardView>
    </template>
    <script setup lang="ts">
    import { DxCardView, DxToolbar, DxItem } from 'devextreme-vue/card-view';
    import { DxSelectBox } from 'devextreme-vue/select-box';
    </script>
    React

    You can use DevExtreme components as toolbar items. Declare an Item element to add a supported component:

    App.js
    import { SelectBox } from 'devextreme-react/select-box';
    import CardView, { Toolbar, Item } from 'devextreme-react/card-view';
    // ...
    function App() {
        return (
            <CardView ... >
                <Toolbar>
                    <Item>
                        <SelectBox>
                            {/* SelectBox properties are specified here */}
                        </SelectBox>
                    </Item>
                </Toolbar>
            </CardView>
        );
    }
  • Custom controls
    To use a custom control, specify a template.