Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://js.devexpress.com/Vue/Documentation/ApiReference/UI_Components/dxDateBox/Configuration/ below:

Vue DateBox Props | Vue Documentation

An object defining configuration properties for the DateBox UI component.

Specifies whether or not the UI component allows an end user to enter a custom value.

Selector: accept-custom-value

Default Value: true

Specifies the shortcut key that sets focus on the UI component.

Selector: access-key

Default Value: undefined

The value of this property will be passed to the accesskey attribute of the HTML element that underlies the UI component.

Specifies whether the UI component changes its visual state as a result of user interaction.

Selector: active-state-enabled

Default Value: true

The UI component switches to the active state when users press down the primary mouse button. When this property is set to true, the CSS rules for the active state apply. You can change these rules to customize the component.

Use this property when you display the component on a platform whose guidelines include the active state change for UI components.

Specifies whether or not adaptive UI component rendering is enabled on a small screen.

Selector: adaptivity-enabled

Default Value: false

While displaying DateBox in your app, you may want to use different layouts for different screen sizes. While desktop monitors provide enough space, mobile screens do not. In this case, you can enable the UI component to have a more compact representation. For this purpose, assign true to the adaptivityEnabled property. In the adaptive mode, the date box is displayed without the digital clock face.

The text displayed on the Apply button.

Specifies the way an end user applies the selected value.

Selector: apply-value-mode

Default Value: 'instantly'

The property accepts the following values.

• "useButtons"
  Enables an end user to apply the selected value or cancel the selection using the Apply and Cancel buttons respectively. When the pickerType is 'calendar', choosing this mode activates the showTodayButton property.

• "instantly"
  Applies the selected value immediately after a user clicks the required value in the drop-down menu. This mode cannot be used if the pickerType is "rollers" or the type is "datetime".

View Demo

Allows you to add custom buttons to the input text field.

Selector: DxButton

Default Value: undefined

Built-in buttons should also be declared in this array. You can find an example in the following demo:

View Demo

Configures the calendar's value picker. Applies only if the pickerType is "calendar".

You can specify most of the Calendar properties in this object except those listed below. These properties are overridden by their DateBox counterparts.

• dateSerializationFormat
• disabledDates
• max
• min
• onValueChanged
• selectionMode
• tabIndex
• value

The nested component that configures the calendarOptions property does not support event bindings and two-way property bindings.

The nested component that configures the calendarOptions property does not support event bindings and two-way property bindings.

The text displayed on the Cancel button.

Specifies the message displayed if the specified date is later than the max value or earlier than the min value.

Selector: date-out-of-range-message

Default Value: 'Value is out of range'

Specifies the date-time value serialization format.

Date-time serialization involves date-time value conversion into a string format for storage or transmission. To ensure proper format detection, specify this property.

Use LDML patterns to pass custom format strings to this property.

dateSerializationFormat does not support all LDML pattern combinations.

For instance, you can specify the following patterns:

• "yyyy-MM-dd"
  A date.

• "yyyy-MM-ddTHH:mm:ss"
  Local date and time.

• "yyyy-MM-ddTHH:mm:ssZ"
  Date and time in UTC.

• "yyyy-MM-ddTHH:mm:ssx", "yyyy-MM-ddTHH:mm:ssxx", "yyyy-MM-ddTHH:mm:ssxxx"
  Date and time with a timezone.

• You can use this property only if you do not specify the initial value. dateSerializationFormat is calculated automatically if you pass a value in the initial configuration.

• If you specify this property, the value will be a string, not a Date object.

• If you use API to change the value, make sure that the value has the same format that you specified in this property.

• This property takes effect only if the forceIsoDateParsing field is set to true in the global configuration object.

• Troubleshooting - Date String Handling Issues

Specifies whether to render the drop-down field's content when it is displayed. If false, the content is rendered immediately.

Selector: defer-rendering

Default Value: true

If you set the deferRendering property to true, wrap the content in the Angular named template.

If you set the deferRendering property to true, wrap the content in the Vue named template.

Specifies whether the UI component responds to user interaction.

View Demo

Specifies dates that users cannot select. Applies only if pickerType is "calendar".

Selector: disabled-dates

Information about the checked date.

Object structure:

DateBox

The UI component's instance.

Date

The currently checked date.

String

The current view: "month", "year", "decade", or "century".

true if the date should be disabled; otherwise false.

Default Value: null

This property accepts an array of dates:

$(function() {
    $("#dateBoxContainer").dxDateBox({
        // ...
        disabledDates: [ 
            new Date("07/1/2017"),  
            new Date("07/2/2017"), 
            new Date("07/3/2017") 
        ]
    });
});

<dx-date-box ...
    [disabledDates]="disabledDates">
</dx-date-box>

import { Component } from '@angular/core';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent {
    disabledDates: Date[] = [ 
        new Date("07/1/2017"),  
        new Date("07/2/2017"), 
        new Date("07/3/2017") 
    ];
}

import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';

import { DxDateBoxModule } from 'devextreme-angular';

@NgModule({
    declarations: [
        AppComponent
    ],
    imports: [
        BrowserModule,
        DxDateBoxModule
    ],
    providers: [ ],
    bootstrap: [AppComponent]
})
export class AppModule { }

<template>
    <DxDateBox ...
        :disabled-dates="disabledDates"
    />
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxDateBox from 'devextreme-vue/date-box';

export default {
    components: {
        DxDateBox
    },
    data() {
        return {
            disabledDates: [ 
                new Date("07/1/2017"),  
                new Date("07/2/2017"), 
                new Date("07/3/2017") 
            ]
        }
    }
}
</script>

import React from 'react';

import 'devextreme/dist/css/dx.light.css';

import DateBox from 'devextreme-react/date-box';

class App extends React.Component {
    constructor() {
        this.disabledDates = [ 
            new Date("07/1/2017"),  
            new Date("07/2/2017"), 
            new Date("07/3/2017") 
        ];
    }
    render() {
        return (
            <DateBox ...
                disabledDates={this.disabledDates} 
            />
        );
    }
}
export default App;

View Demo

Alternatively, pass a function to disabledDates. This function should define the rules that determine whether the checked date is disabled. A separate set of rules should target every view individually.

$(function() {
    $("#dateBoxContainer").dxDateBox({
        // ...
        disabledDates: function(args) {
            const dayOfWeek = args.date.getDay();
            const month = args.date.getMonth();
            const isWeekend = args.view === "month" && (dayOfWeek === 0 || dayOfWeek === 6 );
            const isMarch = (args.view === "year" || args.view === "month") && month === 2;

            return isWeekend || isMarch;
        }
    });
});

<dx-date-box ...
    [disabledDates]="disableDates">
</dx-date-box>

import { Component } from '@angular/core';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent {
    disableDates(args) {
        const dayOfWeek = args.date.getDay();
        const month = args.date.getMonth();
        const isWeekend = args.view === "month" && (dayOfWeek === 0 || dayOfWeek === 6 );
        const isMarch = (args.view === "year" || args.view === "month") && month === 2;

        return isWeekend || isMarch;
    }
}

import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';

import { DxDateBoxModule } from 'devextreme-angular';

@NgModule({
    declarations: [
        AppComponent
    ],
    imports: [
        BrowserModule,
        DxDateBoxModule
    ],
    providers: [ ],
    bootstrap: [AppComponent]
})
export class AppModule { }

<template>
    <DxDateBox ...
        :disabled-dates="disableDates"
    />
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxDateBox from 'devextreme-vue/date-box';

export default {
    components: {
        DxDateBox
    },
    methods: {
        disableDates(args) {
            const dayOfWeek = args.date.getDay();
            const month = args.date.getMonth();
            const isWeekend = args.view === "month" && (dayOfWeek === 0 || dayOfWeek === 6 );
            const isMarch = (args.view === "year" || args.view === "month") && month === 2;

            return isWeekend || isMarch;
        }
    }
}
</script>

import React from 'react';

import 'devextreme/dist/css/dx.light.css';

import DateBox from 'devextreme-react/date-box';

class App extends React.Component {
    disableDates(args) {
        const dayOfWeek = args.date.getDay();
        const month = args.date.getMonth();
        const isWeekend = args.view === "month" && (dayOfWeek === 0 || dayOfWeek === 6 );
        const isMarch = (args.view === "year" || args.view === "month") && month === 2;

        return isWeekend || isMarch;
    }
    render() {
        return (
            <DateBox ...
                disabledDates={this.disableDates} 
            />
        );
    }
}
export default App;

Specifies the date display format. Ignored if the pickerType property is "native"

Specifies a custom template for the drop-down button.

Selector: drop-down-button-template

String

The button's icon.

String

The button's text.

Default Name: 'dropDownButton'

Configures the drop-down field which holds the content.

See Popup Configuration for properties that you can specify in this object.

The nested component that configures the dropDownOptions property does not support event bindings and two-way property bindings.

The nested component that configures the dropDownOptions property does not support event bindings and two-way property bindings.

Specifies the global attributes to be attached to the UI component's container element.

Selector: DxElementAttr

Default Value: {}

$(function(){
    $("#dateBoxContainer").dxDateBox({
        // ...
        elementAttr: {
            id: "elementId",
            class: "class-name"
        }
    });
});

<dx-date-box ...
    [elementAttr]="{ id: 'elementId', class: 'class-name' }">
</dx-date-box>

import { DxDateBoxModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxDateBoxModule
    ],
    // ...
})

<template>
    <DxDateBox ...
        :element-attr="dateBoxAttributes">
    </DxDateBox>
</template>

<script>
import DxDateBox from 'devextreme-vue/date-box';

export default {
    components: {
        DxDateBox
    },
    data() {
        return {
            dateBoxAttributes: {
                id: 'elementId',
                class: 'class-name'
            }
        }
    }
}
</script>

import React from 'react';

import DateBox from 'devextreme-react/date-box';

class App extends React.Component {
    dateBoxAttributes = {
        id: 'elementId',
        class: 'class-name'
    }

    render() {
        return (
            <DateBox ...
                elementAttr={this.dateBoxAttributes}>
            </DateBox>
        );
    }
}
export default App;

Specifies whether the UI component can be focused using keyboard navigation.

Selector: focus-state-enabled

Default Value: true

Specifies the UI component's height.

This property accepts a value of one of the following types:

• Number
  The height in pixels.

• String
  A CSS-accepted measurement of height. For example, "55px", "20vh", "80%", "inherit".

Specifies text for a hint that appears when a user pauses on the UI component.

Specifies whether the UI component changes its state when a user pauses on it.

Selector: hover-state-enabled

Default Value: true

Specifies the attributes to be passed on to the underlying HTML element.

Selector: input-attr

Type: any

Default Value: {}

$(function(){
    $("#dateBoxContainer").dxDateBox({
        // ...
        inputAttr: {
            id: "inputId"
        }
    });
});

<dx-date-box ...
    [inputAttr]="{ id: 'inputId' }">
</dx-date-box>

import { DxDateBoxModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxDateBoxModule
    ],
    // ...
})

<template>
    <DxDateBox
        :input-attr="inputAttr"
    />
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxDateBox from 'devextreme-vue/date-box';

export default {
    components: {
        DxDateBox
    },
    data() {
        return {
            inputAttr: { id: 'inputId' }
        }
    }
}
</script>

import 'devextreme/dist/css/dx.light.css';

import DateBox from 'devextreme-react/date-box';

const inputAttr = { id: 'inputId' };

export default function App() {
    return (
        <DateBox
            inputAttr={inputAttr}
        />
    );
}

@(Html.DevExtreme().DateBox()
    .InputAttr("id", "inputId")
    // ===== or =====
    .InputAttr(new {
        @id = "inputId"
    })
    // ===== or =====
    .InputAttr(new Dictionary<string, object>() {
        { "id", "inputId" }
    })
)

@(Html.DevExtreme().DateBox() _
    .InputAttr("id", "inputId")
    ' ===== or =====
    .InputAttr(New With {
        .id = "inputId"
    })
    ' ===== or =====
    .InputAttr(New Dictionary(Of String, Object) From {
        { "id", "inputId" }
    })
)

To improve accessibility, use this property to specify aria-label for the component.

$(function(){
    $("#dateBoxContainer").dxDateBox({
        // ...
        inputAttr: {
            'aria-label': 'your-label',
        },
    });
});

<dx-date-box ...
    [inputAttr]="{ 'aria-label': 'your-label' }">
</dx-date-box>

<template>
    <DxDateBox
        :input-attr="inputAttr"
    />
</template>

<script>
import DxDateBox from 'devextreme-vue/date-box';

export default {
    components: {
        DxDateBox
    },
    data() {
        return {
            inputAttr: { 'aria-label': 'your-label' }
        }
    }
}
</script>

import DateBox from 'devextreme-react/date-box';

const inputAttr = { 'aria-label': 'your-label' };

export default function App() {
    return (
        <DateBox
            inputAttr={inputAttr}
        />
    );
}

You do not need to specify aria-label if you use label.

Specifies the interval between neighboring values in the popup list in minutes.

This property applies only if the

property is set to

and the

is

.

Specifies the message displayed if the typed value is not a valid date or time.

Selector: invalid-date-message

Default Value: 'Value must be a date or time'

Specifies whether the component's current value differs from the initial value.

Selector: is-dirty

Default Value: false

If

is enabled and the entered value is not a date, the

value does not change.

This property is a read-only flag. You can use it to check if the editor value changed.

$(() => {
    const dateBox = $('#dateBox').dxDateBox({
        // ...
    }).dxDateBox('instance');

    $('#button').dxButton({
        // ...
        onClick () {
            if (dateBox.option('isDirty')) {
                DevExpress.ui.notify("Do not forget to save changes", "warning", 500);
            }
        }
    });
});

import { Component, ViewChild } from '@angular/core';
import { DxDateBoxComponent, DxButtonModule } from 'devextreme-angular';
import notify from 'devextreme/ui/notify';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent {
    @ViewChild('dateBoxRef', { static: false }) dateBox: DxDateBoxComponent;

    onClick () {
        if (this.dateBox.instance.option('isDirty')) {
            notify("Do not forget to save changes", "warning", 500);
        }
    }
}

<dx-date-box ... 
    #dateBoxRef
>
</dx-date-box>
<dx-button ...
    (onClick)="onClick($event)"
>
</dx-button>

<template>
    <DxDateBox ...
        :ref="dateBoxRef"
    >
    </DxDateBox>
    <DxButton ...
        @click="onClick"
    />
</template>

<script>
import 'devextreme/dist/css/dx.light.css';
import DxDateBox from 'devextreme-vue/date-box';
import DxButton from 'devextreme-vue/button';
import notify from 'devextreme/ui/notify';

export default {
    components: {
        DxDateBox,
        DxButton
    },

    data() {
        return {
            dateBoxRef
        }
    },

    methods: {
        onClick () {
            if (this.dateBox.option('isDirty')) {
                notify("Do not forget to save changes", "warning", 500);
            }
        }
    },

    computed: {
        dateBox: function() {
            return this.$refs[dateBoxRef].instance;
        }
    }
}
</script>

import React, { useRef } from 'react';
import DateBox from 'devextreme-react/date-box';
import Button from 'devextreme-react/button';
import 'devextreme/dist/css/dx.light.css';

const App = () => {
    const dateBoxRef = useRef(null);

    const onClick = () => {
        if (this.dateBoxRef.current.instance().option('isDirty')) {
            notify("Do not forget to save changes", "warning", 500);
        }
    };

    return (
        <DateBox ...
            ref={dateBoxRef}
        >
        </DateBox>
        <Button ...
            onClick={onClick}
        />
    );
};

export default App;

• reset

Specifies or indicates whether the editor's value is valid.

Selector: is-valid

Default Value: true

Specifies a text string used to annotate the editor's value.

Specifies the label's display mode.

Selector: label-mode

Default Value: 'static', 'floating' (Material), 'outside' (Fluent)

This property can have one of the following values:

If autofill is enabled in the browser, we do not recommend that you use "floating" mode. The autofill values will overlap the label when it is displayed as a placeholder. Use "static" mode instead.

The last date that can be selected within the UI component.

You can use the following formats to specify the maximum date:

• Date
  Specifies the date directly.

• Number
  Specifies the date with a timestamp (total milliseconds since 1970/01/01).

• String
  Specifies the date as a string value. The UI component supports the following date string formats:

  • "yyyy-MM-dd" (for example, "2017-03-06")
  • "yyyy-MM-ddTHH:mm:ss" (for example, "2017-03-27T16:54:48")
  • "yyyy-MM-ddTHH:mm:ssZ" (for example, "2017-03-27T13:55:41Z")
  • "yyyy-MM-ddTHH:mm:ssx" (for example, "20170327T16:54:10+03")

View Demo

• If this property is undefined, pickerType - "rollers", type - "date" or "datetime", the UI component renders values up to 50 years from the current date.

• If you set the type property to 'time', you still need to use a full Date() as the max, not HH:mm.

• Set the Accepted Date Range

Specifies the maximum number of characters you can enter into the textbox.

Selector: max-length

Default Value: null

If the number of entered characters reaches the value assigned to this property, the UI component does not allow you to enter any more characters.

The minimum date that can be selected within the UI component.

You can use the following formats to specify the minimum date:

• Date
  Specifies the date directly.

• Number
  Specifies the date with a timestamp (total milliseconds since 1970/01/01).

• String
  Specifies the date as a string value. The UI component supports the following date string formats:

  • "yyyy-MM-dd" (for example, "2017-03-06")
  • "yyyy-MM-ddTHH:mm:ss" (for example, "2017-03-27T16:54:48")
  • "yyyy-MM-ddTHH:mm:ssZ" (for example, "2017-03-27T13:55:41Z")
  • "yyyy-MM-ddTHH:mm:ssx" (for example, "20170327T16:54:10+03")

View Demo

• If this property is undefined, pickerType - "rollers", type - "date" or "datetime", the UI component renders values from 01/01/1900.

• If you set the type property to 'time', you still need to use a full Date() as the min, not HH:mm.

• Set the Accepted Date Range

The value to be assigned to the name attribute of the underlying HTML element.

Specify this property if the UI component lies within an HTML form that will be submitted.

A function that is executed when the UI component loses focus after the text field's content was changed using the keyboard.

Selector: @change

Information about the event.

Object structure:

Default Value: null

A function that is executed once the drop-down editor is closed.

Selector: @closed

Information about the event.

Object structure:

Default Value: null

A function that is executed when the UI component is rendered and each time the component is repainted.

Selector: @content-ready

Information about the event.

Object structure:

Default Value: null

A function that is executed when the UI component's input has been copied.

Selector: @copy

Information about the event.

Object structure:

Default Value: null

A function that is executed when the UI component's input has been cut.

Selector: @cut

Information about the event.

Object structure:

Default Value: null

A function that is executed before the UI component is disposed of.

Selector: @disposing

Information about the event.

Object structure:

Default Value: null

A function that is executed when the Enter key has been pressed while the UI component is focused.

Selector: @enter-key

Information about the event.

Object structure:

Default Value: null

A function that is executed when the UI component gets focus.

Selector: @focus-in

Information about the event.

Object structure:

Default Value: null

A function that is executed when the UI component loses focus.

Selector: @focus-out

Information about the event.

Object structure:

Default Value: null

A function used in JavaScript frameworks to save the UI component instance.

Selector: @initialized

Information about the event.

Object structure:

Default Value: null

<dx-date-box ...
    (onInitialized)="saveInstance($event)">
</dx-date-box>

import { Component } from "@angular/core";
import DateBox from "devextreme/ui/data_grid";
// ...
export class AppComponent {
    dateBoxInstance: DateBox;
    saveInstance (e) {
        this.dateBoxInstance = e.component;
    }
}

App.vue (Composition API)

<template>
    <div>
        <DxDateBox ...
            @initialized="saveInstance">
        </DxDateBox>
    </div>
</template>

<script>
import DxDateBox from 'devextreme-vue/date-box';

export default {
    components: {
        DxDateBox
    },
    data: function() {
        return {
            dateBoxInstance: null
        };
    },
    methods: {
        saveInstance: function(e) {
            this.dateBoxInstance = e.component;
        }
    }
};
</script>

<template>
    <div>
        <DxDateBox ...
            @initialized="saveInstance">
        </DxDateBox>
    </div>
</template>

<script setup>
import DxDateBox from 'devextreme-vue/date-box';

let dateBoxInstance = null;

const saveInstance = (e) => {
    dateBoxInstance = e.component;
}
</script>

import DateBox from 'devextreme-react/date-box';

class App extends React.Component {
    constructor(props) {
        super(props);

        this.saveInstance = this.saveInstance.bind(this);
    }

    saveInstance(e) {
        this.dateBoxInstance = e.component;
    }

    render() {
        return (
            <div>
                <DateBox onInitialized={this.saveInstance} />
            </div>
        );
    }
}

• Get a UI component Instance in jQuery

• Get a UI component Instance in Angular

• Get a UI component Instance in Vue

• Get a UI component Instance in React

A function that is executed each time the UI component's input is changed while the UI component is focused.

Selector: @input

Information about the event.

Object structure:

Default Value: null

A function that is executed when a user is pressing a key on the keyboard.

Selector: @key-down

Information about the event.

Object structure:

Default Value: null

A function that is executed when a user releases a key on the keyboard.

Selector: @key-up

Information about the event.

Object structure:

Default Value: null

A function that is executed once the drop-down editor is opened.

Selector: @opened

Information about the event.

Object structure:

Default Value: null

A function that is executed after a UI component property is changed.

Selector: @option-changed

Information about the event.

Object structure:

The modified property's new value.

The UI component's previous value.

String

The modified property if it belongs to the first level. Otherwise, the first-level property it is nested into.

String

The path to the modified property that includes all parent properties.

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

DateBox

The UI component's instance.

Default Value: null

The following example shows how to subscribe to component property changes:

$(function() {
    $("#dateBoxContainer").dxDateBox({
        // ...
        onOptionChanged: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    });
});

<dx-date-box ...
    (onOptionChanged)="handlePropertyChange($event)"> 
</dx-date-box>

import { Component } from '@angular/core'; 

@Component({ 
    selector: 'app-root', 
    templateUrl: './app.component.html', 
    styleUrls: ['./app.component.css'] 
}) 

export class AppComponent { 
    // ...
    handlePropertyChange(e) {
        if(e.name === "changedProperty") { 
            // handle the property change here
        }
    }
}

import { BrowserModule } from '@angular/platform-browser'; 
import { NgModule } from '@angular/core'; 
import { AppComponent } from './app.component'; 
import { DxDateBoxModule } from 'devextreme-angular'; 

@NgModule({ 
    declarations: [ 
        AppComponent 
    ], 
    imports: [ 
        BrowserModule, 
        DxDateBoxModule 
    ], 
    providers: [ ], 
    bootstrap: [AppComponent] 
}) 

export class AppModule { }  

<template> 
    <DxDateBox ...
        @option-changed="handlePropertyChange"
    />            
</template> 

<script>  
import 'devextreme/dist/css/dx.light.css'; 
import DxDateBox from 'devextreme-vue/date-box'; 

export default { 
    components: { 
        DxDateBox
    }, 
    // ...
    methods: { 
        handlePropertyChange: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    } 
} 
</script> 

import React from 'react';  
import 'devextreme/dist/css/dx.light.css'; 

import DateBox from 'devextreme-react/date-box'; 

const handlePropertyChange = (e) => {
    if(e.name === "changedProperty") {
        // handle the property change here
    }
}

export default function App() { 
    return ( 
        <DateBox ...
            onOptionChanged={handlePropertyChange}
        />        
    ); 
} 

A function that is executed when the UI component's input has been pasted.

Selector: @paste

Information about the event.

Object structure:

Default Value: null

A function that is executed after the UI component's value is changed.

Selector: @value-changed

Information about the event.

Object structure:

Default Value: null

Specifies whether or not the drop-down editor is displayed.

Specifies whether a user can open the drop-down list by clicking a text field.

Selector: open-on-field-click

Default Value: false

Specifies the type of the date/time picker.

Selector: picker-type

Default Value: 'calendar', 'native' (Android, iOS)

This property accepts the following values:

• "calendar"
  The DateBox displays the Calendar UI component for users to select a date. Set the type property to "date" or "datetime" to use this picker type.

• "list"
  The DateBox displays a list of time values. Set the type property to "time" to use this picker type.

• "native"
  The picker type depends on the current platform or web browser.

  • The "native" picker overrides DevExtreme localization settings. The component formats dates using locales of user devices.
  • The default behaviour of DateBox is to emit the onValueChanged event when users finish editing the component value. If you set the picker type to "native", DateBox emits onValueChanged as users edit the value.

• "rollers"
  The DateBox displays rollers for users to select date and time. Users cannot edit the selected value in the input field.

  The "rollers" picker type is designed for mobile devices. For desktop applications, use one of the others.

View Demo

Specifies a placeholder for the input field.

This text is also shown in the date picker's title in the following cases:

• If the pickerType is "rollers".
• If the application runs on an iOS device and the pickerType is not "native".

View Demo

Specifies whether the editor is read-only.

Selector: read-only

Default Value: false

When this property is set to true, the following applies:

• The editor's value cannot be changed using the UI.
• Built-in action buttons are invisible.

• Custom action buttons are visible but disabled. If a button should not be disabled, set its disabled property to false:

  jQuery

  $(function() {
      $("#dateBoxContainer").dxDateBox({
          // ...
          buttons: [{
              name: "myCustomButton",
              location: "after",
              options: {
                  onClick: function(e) {
                      // ...
                  },
                  disabled: false
              }
          }]
      });
  });

  Angular

  <dx-date-box ... >
      <dxi-button
          name="myCustomButton"
          location="after"
          [options]="myCustomButtonConfig">
      </dxi-button>
  </dx-date-box>

  import { Component } from '@angular/core';
  
  @Component({
      selector: 'app-root',
      templateUrl: './app.component.html',
      styleUrls: ['./app.component.css']
  })
  export class AppComponent {
      myCustomButtonConfig = {
          onClick: (e) => {
              // ...
          },
          disabled: false
      };
  }

  import { BrowserModule } from '@angular/platform-browser';
  import { NgModule } from '@angular/core';
  import { AppComponent } from './app.component';
  
  import { DxDateBoxModule } from 'devextreme-angular';
  
  @NgModule({
      declarations: [
          AppComponent
      ],
      imports: [
          BrowserModule,
          DxDateBoxModule
      ],
      providers: [ ],
      bootstrap: [AppComponent]
  })
  export class AppModule { }

  Vue

  <template>
      <DxDateBox ... >
          <DxDateBoxButton
              name="myCustomButton"
              location="after"
              :options="myCustomButtonConfig"
          />
      </DxDateBox>
  </template>
  
  <script>
  import 'devextreme/dist/css/dx.light.css';
  
  import DxDateBox, {
      DxButton as DxDateBoxButton
  } from 'devextreme-vue/date-box';
  
  export default {
      components: {
          DxDateBox,
          DxDateBoxButton
      },
      data() {
          return {
              myCustomButtonConfig: {
                  onClick: (e) => {
                      // ...
                  },
                  disabled: false
              }
          }
      }
  }
  </script>

  React

  import React from 'react';
  
  import 'devextreme/dist/css/dx.light.css';
  
  import DateBox, {
      Button as DateBoxButton
  } from 'devextreme-react/date-box';
  
  class App extends React.Component {
      myCustomButtonConfig = {
          onClick: (e) => {
              // ...
          },
          disabled: false
      };
      render() {
          return (
              <DateBox>
                  <DateBoxButton
                      name="myCustomButton"
                      location="after"
                      options={this.myCustomButtonConfig}
                  />
              </DateBox>
          );
      }
  }
  export default App;

  You can also hide a custom action button when the UI component becomes read-only. Set the button's visible property to false in the onOptionChanged function. To get the button, use the getButton(name) method:

  jQuery

  $(function() {
      $("#dateBoxContainer").dxDateBox({
          // ...
          buttons: [{
              name: "myCustomButton",
              // ...
          }],
          onOptionChanged: function(e) {
              if(e.name == "readOnly") {
                  const myButton = e.component.getButton("myCustomButton");
                  myButton.option("visible", !e.value); // Hide the button when readOnly: true
              }
          }
      });
  });

  Angular

  <dx-date-box ...
      (onOptionChanged)="changeButtonState">
      <dxi-button
          name="myCustomButton"
          ...
      ></dxi-button>
  </dx-date-box>

  import { Component } from '@angular/core';
  
  @Component({
      selector: 'app-root',
      templateUrl: './app.component.html',
      styleUrls: ['./app.component.css']
  })
  export class AppComponent {
      changeButtonState(e) {
          if(e.name == 'readOnly') {
              let myButton = e.component.getButton('myCustomButton');
              myButton.option('visible', !e.value); // Hide the button when readOnly: true
          }
      }
  }

  import { BrowserModule } from '@angular/platform-browser';
  import { NgModule } from '@angular/core';
  import { AppComponent } from './app.component';
  
  import { DxDateBoxModule } from 'devextreme-angular';
  
  @NgModule({
      declarations: [
          AppComponent
      ],
      imports: [
          BrowserModule,
          DxDateBoxModule
      ],
      providers: [ ],
      bootstrap: [AppComponent]
  })
  export class AppModule { }

  Vue

  <template>
      <DxDateBox ...
          @option-changed="changeButtonState">
          <DxDateBoxButton
              name="myCustomButton"
              ...
          />
      </DxDateBox>
  </template>
  
  <script>
  import 'devextreme/dist/css/dx.light.css';
  
  import DxDateBox, {
      DxButton as DxDateBoxButton
  } from 'devextreme-vue/date-box';
  
  export default {
      components: {
          DxDateBox,
          DxDateBoxButton
      },
      data() {
          return {
              // ...
          }
      },
      methods: {
          changeButtonState(e) {
              if(e.name == 'readOnly') {
                  let myButton = e.component.getButton('myCustomButton');
                  myButton.option('visible', !e.value); // Hide the button when readOnly: true
              }
          }
      }
  }
  </script>

  React

  import React from 'react';
  
  import 'devextreme/dist/css/dx.light.css';
  
  import DateBox, {
      Button as DateBoxButton
  } from 'devextreme-react/date-box';
  
  class App extends React.Component {
      changeButtonState(e) {
          if(e.name == 'readOnly') {
              let myButton = e.component.getButton('myCustomButton');
              myButton.option('visible', !e.value); // Hide the button when readOnly: true
          }
      }
      render() {
          return (
              <DateBox ...
                  onOptionChanged={this.changeButtonState}>
                  <DateBoxButton
                      name="myCustomButton"
                      ...
                  />
              </DateBox>
          );
      }
  }
  export default App;

Switches the UI component to a right-to-left representation.

Selector: rtl-enabled

Default Value: false

When this property is set to true, the UI component text flows from right to left, and the layout of elements is reversed. To switch the entire application/site to the right-to-left representation, assign true to the rtlEnabled field of the object passed to the DevExpress.config(config) method.

DevExpress.config({
    rtlEnabled: true
});

DataGrid Demo Navigation UI Demo Editors Demo

Specifies whether to show the analog clock in the value picker. Applies only if type is "datetime" and pickerType is "calendar".

Selector: show-analog-clock

Default Value: true

Specifies whether to display the Clear button in the UI component.

Selector: show-clear-button

Default Value: false

The Clear button calls the reset method.

The Clear button can be displayed only if the

is not

or if the native date-time picker includes it.

View Demo

Specifies whether the drop-down button is visible.

Selector: show-drop-down-button

Default Value: true

Specifies whether or not the UI component checks the inner text for spelling mistakes.

Specifies how the UI component's text field is styled.

Selector: styling-mode

Default Value: 'outlined', 'filled' (Material)

The following styles are available:

You can also use the global editorStylingMode setting to specify how the text fields of all editors in your application are styled.

Specifies the number of the element when the Tab key is used for navigating.

Selector: tab-index

Default Value: 0

The value of this property will be passed to the tabindex attribute of the HTML element that underlies the UI component.

The read-only property that stores the text displayed by the UI component input element.

The text displayed on the Today button.

A format used to display date/time information.

You can assign the following values to this property:

• date - the UI component displays only the date;
• time - the UI component displays only the time;
• datetime - the UI component displays both the date and time.

View Demo

Specifies whether to control user input using a mask created based on the displayFormat.

Information on the broken validation rule. Contains the first item from the validationErrors array.

Selector: validation-error

Type: any

Default Value: null

An array of validation errors.

Selector: validation-errors

Default Value: null

DateBox updates this property automatically as it validates values. You can also update validationErrors manually to display custom errors and implement custom validation logic. The following code snippet demonstrates how to define items in this array:

$('#date-box').dxDateBox({
    isValid: false,
    validationErrors: [{ message: "Custom validation error" }],
})

<dx-date-box
    [isValid]="false"
    [validationErrors]="validationErrors"
></dx-date-box>

import { DxDateBoxComponent } from 'devextreme-angular/ui/date-box'

export class AppComponent {
    validationErrors = [
        { message: 'Custom validation error' }
    ];
}

<script setup lang="ts">
import { DxDateBox } from 'devextreme-vue/date-box';

const validationErrors = [
    { message: 'Custom validation error' }
];
</script>

<template>
    <DxDateBox 
        :is-valid="false"
        :validation-errors="validationErrors"
    />
</template>

import { DateBox } from 'devextreme-react/date-box';

const validationErrors = [
    { message: 'Custom validation error' }
];

function App(): JSX.Element {
    return (
        <DateBox
            isValid={false}
            validationErrors={validationErrors}
        />
    )
}

Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed.

Selector: validation-message-mode

Default Value: 'auto'

The following property values are possible:

• auto
  The tooltip with the message is displayed when the editor is in focus.
• always
  The tooltip with the message is not hidden when the editor loses focus.

Specifies the position of a validation message relative to the component. The validation message describes the validation rules that this component's value does not satisfy.

Selector: validation-message-position

Default Value: 'auto'

This property also applies position rules to the component's inner validation message.

The following example positions a validation message at the component's right:

$(function() {
    $("#dateBoxContainer").dxDateBox({
        // ...
        validationMessagePosition: 'right'
    }).dxValidator({
        validationRules: [{
            type: 'required',
            message: 'Required',
        }],
    });
});

<dx-date-box ...
    validationMessagePosition="right">
    <dx-validator>
        <dxi-validation-rule
            type="required"
            message="Required"
        >
        </dxi-validation-rule>
    </dx-validator>
</dx-date-box>

<template>
    <DxDateBox ...
        validation-message-position="right"
    >
        <DxValidator>
            <DxRequiredRule message="Required" />
        </DxValidator>
    </DxDateBox>
</template>

<script>
    // ...
</script>

import React from 'react';
// ...

function App() {
    return (
        <DateBox ...
            validationMessagePosition="right"
        >
            <Validator>
                <RequiredRule message="Required" />
            </Validator>
        </DateBox>
    ); 

};
export default App;

Indicates or specifies the current validation status.

Selector: validation-status

Default Value: 'valid'

The following table illustrates the validation status indicators:

When you assign "invalid" to validationStatus, you can also use the validationErrors array to set an error message as shown below:

$(function() {
    const dateBox = $("#dateBoxContainer").dxDateBox({
        // ...
    }).dxDateBox("instance");

    function setInvalidStatus(message) {
        dateBox.option({
            validationStatus: "invalid",
            validationErrors: [{ message: message }]
        });
    }
});

<dx-date-box
    [validationStatus]="validationStatus"
    [validationErrors]="validationErrors">
</dx-date-box>

// ...
export class AppComponent {
    validationStatus: string = "valid";
    validationErrors: any;
    // ...
    setInvalidStatus(message) {
        this.validationStatus = "invalid";
        this.validationErrors = [{ message: message }];
    }
}

<template>
    <DxDateBox ...
        :validation-status="validationStatus"
        :validation-errors="validationErrors"
    />
</template>

<script>
    // ...
    export default {
        // ...
        data() {
            return {
                validationStatus: "valid",
                validationErrors: []
            }
        },
        methods: {
            setInvalidStatus(message) {
                this.validationStatus = "invalid";
                this.validationErrors = [{ message: message }];
            }
        }
    }
</script>

import React, { useState } from 'react';
// ...

function App() {
    const [validationStatus, setValidationStatus] = useState("valid");
    const [validationErrors, setValidationErrors] = useState([]);

    const setInvalidStatus = message => {
        setValidationStatus("invalid");
        setValidationErrors([{ message: message }]);
    }

    return (
        <DateBox
            validationStatus={validationStatus}
            validationErrors={validationErrors}
        />
    ); 

};
export default App;

DateBox includes an internal validation mechanism. If the

is changed,

will be updated correspondingly.

Specifies the currently selected date and time.

You can use the following formats to specify the current UI component value:

• Date
  Specifies the date directly.

• Number
  Specifies the date with a timestamp (total milliseconds since 1970/01/01).

• String
  Specifies the date as a string value. The UI component supports the following date string formats:

  • "yyyy-MM-dd" (for example, "2017-03-06")
  • "yyyy-MM-ddTHH:mm:ss" (for example, "2017-03-27T16:54:48")
  • "yyyy-MM-ddTHH:mm:ssZ" (for example, "2017-03-27T13:55:41Z")
  • "yyyy-MM-ddTHH:mm:ssx" (for example, "20170327T16:54:10+03")

If an end user changes the UI component value, the new value is saved in the same format as the initial value.

View Demo

• displayFormat

Specifies the DOM events after which the UI component's value should be updated.

Selector: value-change-event

Default Value: 'change'

This property accepts a single event name or several names separated by spaces.

The recommended events are "keyup", "blur", "change", "input", and "focusout", but you can use other events as well.

• onValueChanged

Specifies whether the UI component is visible.

Specifies the UI component's width.

This property accepts a value of one of the following types:

• Number
  The width in pixels.

• String
  A CSS-accepted measurement of width. For example, "55px", "20vw", "80%", "auto", "inherit".

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4