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

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

Vue Button Props | Vue Documentation

An object defining configuration properties for the Button 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(){
    $("#buttonContainer").dxButton({
        // ...
        elementAttr: {
            id: "elementId",
            class: "class-name"
        }
    });
});

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

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

<template>
    <DxButton ...
        :element-attr="buttonAttributes">
    </DxButton>
</template>

<script>
import DxButton from 'devextreme-vue/button';

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

import React from 'react';

import Button from 'devextreme-react/button';

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

    render() {
        return (
            <Button ...
                elementAttr={this.buttonAttributes}>
            </Button>
        );
    }
}
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".

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 icon to be displayed on the button.

A function that is executed when the Button is clicked or tapped.

Selector: @click

Information about the event.

Object structure:

Default Value: null

To validate the editors that are related to the validation group specified for this button, use the validationGroup field of the object passed as the event handler's parameter. The validationGroup object has the following structure.

• group
  The name or object of the validation group that is assigned to the button's validationGroup property.
• validators
  An array of Validator UI components that are included to the validation group.
• validate()
  The method that allows you to validate the UI components included in the validation group.
• validated
  The event that occurs after the group is validated. You can attach/detach a handler using the on(eventName, eventHandler)/off(eventName) methods of the group.

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

$('#button').dxButton({
    text: 'Confirm',
    onContentReady(e) {
        e.element.focus()
    }
});

<dx-button
    text="Confirm"
    (onContentReady)="handleContentReady($event)"
></dx-button>

import { DxButtonComponent, type DxButtonTypes } from 'devextreme-angular/ui/button'
// ...

export class AppComponent {
    handleContentReady(e: DxButtonTypes.ContentReadyEvent) {
        e.component.focus();
    }
}

<template>
    <DxButton
        text="Confirm"
        @contentReady="handleContentReady($event)"
    />
</template>

<script setup lang="ts">
import { DxButton, type DxButtonTypes } from 'devextreme-vue/button';

function handleContentReady(e: DxButtonTypes.ContentReadyEvent) {
    e.component.focus();
}

</script>

import { Button, type ButtonTypes } from 'devextreme-react/button';

function handleContentReady(e: ButtonTypes.ContentReadyEvent) {
    e.component.focus();
}

function App() {
    return (
        <Button
            text="Confirm"
            onContentReady={handleContentReady}
        />
    )
}

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

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

App.vue (Composition API)

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

<script>
import DxButton from 'devextreme-vue/button';

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

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

<script setup>
import DxButton from 'devextreme-vue/button';

let buttonInstance = null;

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

import Button from 'devextreme-react/button';

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

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

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

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

Button

The UI component's instance.

Default Value: null

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

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

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

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

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

export class AppModule { }  

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

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

export default { 
    components: { 
        DxButton
    }, 
    // ...
    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 Button from 'devextreme-react/button'; 

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

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

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 how the button is styled.

Selector: styling-mode

Default Value: 'contained'

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.

Specifies a custom template for the Button UI component.

String

The button's icon.

String

The button's text.

Default Name: 'content'

The text displayed on the button.

Specifies the button type.

DevExtreme supplies the following button types:

You can also specify your own button type and define its CSS rules as shown in the example:

$(function() {
    $("#button").dxButton({
        // ...
        type: "warning"
    });
});

.dx-button.dx-button-warning {
    background-color: #ffc107;
}

<dx-button ...
    type="warning"
/>

::ng-deep .dx-button.dx-button-warning {
    background-color: #ffc107;
}

<template>
    <DxButton ...
        type="warning"
    />
</template>

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

<style>
    .dx-button.dx-button-warning {
        background-color: #ffc107;
    }
</style>

function App() {
    return (
        <Button ...
            type="warning" 
        />
    );
};

export default App;

.dx-button.dx-button-warning {
    background-color: #ffc107;
}

Note that buttons have a white background when you move them to the Toolbar. We recommend that you use the 'normal' type for such buttons, otherwise the button text is not visible. You can also define custom CSS rules to override the initial styles.

View Demo

• stylingMode

Specifies whether the button submits an HTML form.

Selector: use-submit-behavior

Default Value: false

If this property is set to true, users can click the button to validate the validation group and submit the HTML form. If the group contains async rules, the form is not submitted until they are checked.

If the onClick event handler is specified, it is executed before validation and form submission.

If you need to cancel form submission, handle a form's submit event.

View Demo

Specifies the name of the validation group to be accessed in the click event handler.

Selector: validation-group

Default Value: undefined

When using a button to validate several editors on a page, the button must "know" in which validation group these editors are located.

Specify the validationGroup configuration property for the button. Assign the validation group name specified for the validationGroup property of the validators that extend the editors to be validated.

• Validate Several Editor Values

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