A RetroSearch Logo

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

Search Query:

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

Vue Menu Props | Vue Documentation

An object defining configuration properties for the Menu 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 adaptive rendering is enabled. This property is in effect only if the orientation is "horizontal".

Selector: adaptivity-enabled

Default Value: false

If you enable adaptive rendering, the Menu is shown as a list icon, and Menu items are arranged hierarchically like TreeView items. This functionality is enabled only if the container's width is less than the Menu width.

The following code example sets the container's width to 400 pixels, sets the Menu width to 500 pixels, and enables adaptive rendering to demonstrate the behavior described above.

jQuery
$(function() {
    $("#menu").dxMenu({
        // ...
        adaptivityEnabled: true,
        width: 500
    });
});
<div id="container">
    <div id="menu"></div>
</div>
#container {
    width: 400px;
}
Angular
<div id="container">
    <dx-menu ...
        [adaptivityEnabled]="true"
        [width]="500"
    >
    </dx-menu>
</div>
#container {
    width: 400px;
}
Vue
<template>
    <div id="container">
        <DxMenu ...
            :adaptivity-enabled="true"
            :width="500"
        />
    </div>
</template>

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

    import DxMenu from 'devextreme-vue/menu';

    export default {
        components: {
            DxMenu
        },
        data() {
            return {
                // ...
            };
        }
    };
</script>

<style>
    #container {
        width: 400px;
    }
</style>
React
import React from 'react';
import 'devextreme/dist/css/dx.light.css';

import { Menu } from 'devextreme-react/menu';

function App() {
    return (
        <div id="container">
            <Menu ...
                adaptivityEnabled={true}
                width={500}
            />
        </div>
    );
}

export default App;
#container {
    width: 400px;
}

Configures UI component visibility animations. This object contains two fields: show and hide.

Selector: DxAnimation

Default Value: { show: { type: 'fade', from: 0, to: 1, duration: 100 }, hide: { type: 'fade', from: 1, to: 0, duration: 100 } }

Set this object to null or undefined to disable animation.

Specifies the name of the CSS class to be applied to the root menu level and all submenus.

Selector: css-class

Default Value: ''

Use this property to customize the current menu in isolation from other menus created on the same page.

Binds the UI component to data.

Selector: data-source

Default Value: null

The Menu works with collections of string values or objects.

Depending on your data source, bind Menu to data as follows. If the data source provides objects, also specify the itemTemplate. You can skip this part if the objects contain fields described in the items section.

Regardless of the data source on the input, the Menu always wraps it in the DataSource object. This object allows you to sort, filter, group, and perform other data shaping operations. To get its instance, call the getDataSource() method.

Review the following notes about data binding:

jQuery Angular Vue React

Specifies whether the UI component responds to user interaction.

Specifies the name of the data source item field whose value defines whether or not the corresponding UI component item is disabled.

Selector: disabled-expr

Default Value: 'disabled'

Specifies the data field whose values should be displayed.

Selector: display-expr

Function parameters:

The current item's data object.

Default Value: 'text'

Set this property to the name of a data field that provides displayed values...

... or to a function that returns the displayed value:

displayExpr: function(item) {
    // "item" can be null
    return item && 'ID: ' + item.id + ', Name: ' + item.name;
}

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

Selector: DxElementAttr

Default Value: {}

jQuery
$(function(){
    $("#menuContainer").dxMenu({
        // ...
        elementAttr: {
            id: "elementId",
            class: "class-name"
        }
    });
});
Angular
<dx-menu ...
    [elementAttr]="{ id: 'elementId', class: 'class-name' }">
</dx-menu>
import { DxMenuModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxMenuModule
    ],
    // ...
})
Vue
<template>
    <DxMenu ...
        :element-attr="menuAttributes">
    </DxMenu>
</template>

<script>
import DxMenu from 'devextreme-vue/menu';

export default {
    components: {
        DxMenu
    },
    data() {
        return {
            menuAttributes: {
                id: 'elementId',
                class: 'class-name'
            }
        }
    }
}
</script>
React
import React from 'react';

import Menu from 'devextreme-react/menu';

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

    render() {
        return (
            <Menu ...
                elementAttr={this.menuAttributes}>
            </Menu>
        );
    }
}
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:

Specifies whether or not the submenu is hidden when the mouse pointer leaves it.

Selector: hide-submenu-on-mouse-leave

Default Value: false

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

Holds an array of menu items.

The items array can contain:

If you need to update the UI component items, reassign the entire items array as shown in the following example:

menuInstance.option('items', newItems);

As an alternative to items, you can use the dataSource property. It accepts the DataSource object, whose underlying stores provide an API that allows you to update individual items without reassigning the entire item collection.

Do not use the items property if you use dataSource, and vice versa.

Specifies which data field contains nested items.

Selector: items-expr

Default Value: 'items'

Specifies a custom template for items.

Selector: item-template

Template Data:

Object

The item object to be rendered.

Default Name: 'item'

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

Selector: @content-ready

Function parameters:

Information about the event.

Object structure:

Default Value: null

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

Selector: @disposing

Function parameters:

Information about the event.

Object structure:

Default Value: null

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

Selector: @initialized

Function parameters:

Information about the event.

Object structure:

Default Value: null

Angular
<dx-menu ...
    (onInitialized)="saveInstance($event)">
</dx-menu>
import { Component } from "@angular/core";
import Menu from "devextreme/ui/data_grid";
// ...
export class AppComponent {
    menuInstance: Menu;
    saveInstance (e) {
        this.menuInstance = e.component;
    }
}
Vue

App.vue (Composition API)

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

<script>
import DxMenu from 'devextreme-vue/menu';

export default {
    components: {
        DxMenu
    },
    data: function() {
        return {
            menuInstance: null
        };
    },
    methods: {
        saveInstance: function(e) {
            this.menuInstance = e.component;
        }
    }
};
</script>
<template>
    <div>
        <DxMenu ...
            @initialized="saveInstance">
        </DxMenu>
    </div>
</template>

<script setup>
import DxMenu from 'devextreme-vue/menu';

let menuInstance = null;

const saveInstance = (e) => {
    menuInstance = e.component;
}
</script>
React
import Menu from 'devextreme-react/menu';

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

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

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

    render() {
        return (
            <div>
                <Menu onInitialized={this.saveInstance} />
            </div>
        );
    }
}
See Also jQuery Angular Vue React

A function that is executed when a collection item is clicked or tapped.

Selector: @item-click

Function parameters:

Information about the event.

Object structure:

Default Value: null

A function that is executed when a collection item is right-clicked or pressed.

Selector: @item-context-menu

Function parameters:

Information about the event.

Object structure:

Default Value: null

A function that is executed after a collection item is rendered.

Selector: @item-rendered

Function parameters:

Information about the event.

Object structure:

Default Value: null

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

Selector: @option-changed

Function parameters:

Information about the event.

Object structure:

Name Type Description value any

The modified property's new value.

previousValue any

The UI component's previous value.

name

String

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

fullName

String

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

element

HTMLElement | jQuery

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

component

Menu

The UI component's instance.

Default Value: null

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

jQuery
$(function() {
    $("#menuContainer").dxMenu({
        // ...
        onOptionChanged: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    });
});
Angular
<dx-menu ...
    (onOptionChanged)="handlePropertyChange($event)"> 
</dx-menu>
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 { DxMenuModule } from 'devextreme-angular'; 

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

export class AppModule { }  
Vue
<template> 
    <DxMenu ...
        @option-changed="handlePropertyChange"
    />            
</template> 

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

export default { 
    components: { 
        DxMenu
    }, 
    // ...
    methods: { 
        handlePropertyChange: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    } 
} 
</script> 
React
import React from 'react';  
import 'devextreme/dist/css/dx.light.css'; 

import Menu from 'devextreme-react/menu'; 

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

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

A function that is executed when a collection item is selected or selection is canceled.

Selector: @selection-changed

Function parameters:

Information about the event.

Object structure:

Name Type Description removedItems

Array<any>

The data of the items removed from selection.

element

HTMLElement | jQuery

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

component

Menu

The UI component's instance.

addedItems

Array<any>

The data of the selected items.

Default Value: null

A function that is executed after a submenu is hidden.

Selector: @submenu-hidden

Function parameters:

Information about the event.

Object structure:

Default Value: null

A function that is executed before a submenu is hidden.

Selector: @submenu-hiding

Function parameters:

Information about the event.

Object structure:

Default Value: null

A function that is executed before a submenu is displayed.

Selector: @submenu-showing

Function parameters:

Information about the event.

Object structure:

Default Value: null

View Demo

A function that is executed after a submenu is displayed.

Selector: @submenu-shown

Function parameters:

Information about the event.

Object structure:

Default Value: null

Specifies whether the menu has horizontal or vertical orientation.

Default Value: 'horizontal'

View Demo

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 an item is selected if a user clicks it.

Selector: select-by-click

Default Value: false

To enable selection, set this property to true and the selectionMode property to 'single'.

Specifies the name of the data source item field whose value defines whether or not the corresponding UI component items is selected.

Selector: selected-expr

Default Value: 'selected'

The selected item object.

Selector: selected-item

Type: any

Default Value: null

Specifies the selection mode supported by the menu.

Selector: selection-mode

Default Value: none

Accepted Values: 'multiple' | 'single' | 'all' | 'none'

To select an item on click and to visually display the selection, set the selectByClick property to true. Note that in this case the selectionMode should be "single".

Specifies properties for showing and hiding the first level submenu.

Selector: DxShowFirstSubmenuMode

Default Value: { name: 'onClick', delay: { show: 50, hide: 300 } }

If you assign a string that specifies the mode name to this property, the UI component will use the default delay value.

showFirstSubmenuMode: "onHover"

View Demo

Specifies properties of submenu showing and hiding.

Selector: DxShowSubmenuMode

Default Value: { name: 'onHover', delay: { show: 50, hide: 300 } }

By default, the secondary-level submenus of the Menu UI component are displayed on the same event as the first-level submenu. To set another event for displaying secondary-level submenus, use the showSubmenuMode property. Alternatively, you can change the event on which the first-level submenu is displayed. For this purpose, use the showFirstSubmenuMode property.

Specifies the direction at which the submenus are displayed.

Selector: submenu-direction

Default Value: 'auto'

By default, the first submenu is displayed so that it is visible totally, based on the menu location on the page. Use the submenuDirection property to display the first submenu at the bottom or at the top of a root item when the UI component's orientation is horizontal, and to the left or to the right when orientation is vertical.

View Demo

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 whether the UI component is visible.

Specifies the UI component's width.

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

Feel free to share topic-related thoughts here.
If you have technical questions, please create a support ticket in the DevExpress Support Center.
Thank you for the feedback!

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