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

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

Vue Switch Props | Vue Documentation

An object defining configuration properties for the Switch UI component.

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 the UI component responds to user interaction.

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

Selector: DxElementAttr

Default Value: {}

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

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

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

<template>
    <DxSwitch ...
        :element-attr="switchAttributes">
    </DxSwitch>
</template>

<script>
import DxSwitch from 'devextreme-vue/switch';

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

import React from 'react';

import Switch from 'devextreme-react/switch';

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

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

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

Selector: focus-state-enabled

Default Value: true (desktop)

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".

The property affects only the size of the switch wrapper element. To specify the size of another switch elements, provide the appropriate CSS rules.

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 whether the component's current value differs from the initial value.

Selector: is-dirty

Default Value: false

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

$(() => {
    const switch = $('#switch').dxSwitch({
        // ...
    }).dxSwitch('instance');

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

import { Component, ViewChild } from '@angular/core';
import { DxSwitchComponent, 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('switchRef', { static: false }) switch: DxSwitchComponent;

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

<dx-switch ... 
    #switchRef
>
</dx-switch>
<dx-button ...
    (onClick)="onClick($event)"
>
</dx-button>

<template>
    <DxSwitch ...
        :ref="switchRef"
    >
    </DxSwitch>
    <DxButton ...
        @click="onClick"
    />
</template>

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

export default {
    components: {
        DxSwitch,
        DxButton
    },

    data() {
        return {
            switchRef
        }
    },

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

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

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

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

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

    return (
        <Switch ...
            ref={switchRef}
        >
        </Switch>
        <Button ...
            onClick={onClick}
        />
    );
};

export default App;

• reset

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

Selector: is-valid

Default Value: true

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 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 before the UI component is disposed of.

Selector: @disposing

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-switch ...
    (onInitialized)="saveInstance($event)">
</dx-switch>

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

App.vue (Composition API)

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

<script>
import DxSwitch from 'devextreme-vue/switch';

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

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

<script setup>
import DxSwitch from 'devextreme-vue/switch';

let switchInstance = null;

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

import Switch from 'devextreme-react/switch';

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

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

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

    render() {
        return (
            <div>
                <Switch 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 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.

Switch

The UI component's instance.

Default Value: null

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

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

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

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 { DxSwitchModule } from 'devextreme-angular'; 

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

export class AppModule { }  

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

<script>  
import 'devextreme/dist/css/dx.light.css'; 
import DxSwitch from 'devextreme-vue/switch'; 

export default { 
    components: { 
        DxSwitch
    }, 
    // ...
    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 Switch from 'devextreme-react/switch'; 

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

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

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 the editor is read-only.

Selector: read-only

Default Value: false

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 the text displayed when the UI component is switched off.

Selector: switched-off-text

Default Value: 'OFF'

The UI component may or may not display the text depending on the current theme.

Specifies the text displayed when the UI component is switched on.

Selector: switched-on-text

Default Value: 'ON'

The UI component may or may not display the text depending on the current theme.

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.

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

Switch 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:

$('#switch').dxSwitch({
    isValid: false,
    validationErrors: [{ message: "Custom validation error" }],
})

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

import { DxSwitchComponent } from 'devextreme-angular/ui/switch'

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

<script setup lang="ts">
import { DxSwitch } from 'devextreme-vue/switch';

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

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

import { Switch } from 'devextreme-react/switch';

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

function App(): JSX.Element {
    return (
        <Switch
            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: 'bottom'

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

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

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

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

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

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

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

};
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 switch = $("#switchContainer").dxSwitch({
        // ...
    }).dxSwitch("instance");

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

<dx-switch
    [validationStatus]="validationStatus"
    [validationErrors]="validationErrors">
</dx-switch>

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

<template>
    <DxSwitch ...
        :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 (
        <Switch
            validationStatus={validationStatus}
            validationErrors={validationErrors}
        />
    ); 

};
export default App;

A Boolean value specifying whether the current switch state is "On" or "Off".

View Demo

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