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

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

Vue ContextMenu Props | Vue Documentation

An object defining configuration properties for the ContextMenu 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.

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 ContextMenu works with collections of string values or objects.

Depending on your data source, bind ContextMenu 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.

• Data Array
  Assign the array to the dataSource option.

• Read-Only Data in JSON Format
  Set the dataSource property to the URL of a JSON file or service that returns JSON data.

• OData
  Implement an ODataStore.

• Web API, PHP, MongoDB
  Use one of the following extensions to enable the server to process data according to the protocol DevExtreme UI components use:

  • DevExtreme.AspNet.Data
  • DevExtreme-PHP-Data
  • devextreme-query-mongodb

  Then, use the createStore method to configure access to the server on the client as shown below. This method is part of DevExtreme.AspNet.Data.

  jQuery

  $(function() {
      let serviceUrl = "https://url/to/my/service";
      $("#contextMenuContainer").dxContextMenu({
          // ...
          dataSource: DevExpress.data.AspNet.createStore({
              key: "ID",
              loadUrl: serviceUrl + "/GetAction",
              insertUrl: serviceUrl + "/InsertAction",
              updateUrl: serviceUrl + "/UpdateAction",
              deleteUrl: serviceUrl + "/DeleteAction"
          })
      })
  });

  Angular

  import { Component } from '@angular/core';
  import CustomStore from 'devextreme/data/custom_store';
  import { createStore } from 'devextreme-aspnet-data-nojquery';
  
  @Component({
      selector: 'app-root',
      templateUrl: './app.component.html',
      styleUrls: ['./app.component.css']
  })
  export class AppComponent {
      store: CustomStore;
      constructor() {
          let serviceUrl = "https://url/to/my/service";
          this.store = createStore({
              key: "ID",
              loadUrl: serviceUrl + "/GetAction",
              insertUrl: serviceUrl + "/InsertAction",
              updateUrl: serviceUrl + "/UpdateAction",
              deleteUrl: serviceUrl + "/DeleteAction"
          })
      }
  }

  <dx-context-menu ...
      [dataSource]="store">
  </dx-context-menu>

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

  Vue

  <template> 
      <DxContextMenu ...
          :data-source="store" />
  </template>
  
  <script>
  import 'devextreme/dist/css/dx.light.css';
  
  import CustomStore from 'devextreme/data/custom_store';
  import { createStore } from 'devextreme-aspnet-data-nojquery';
  import { DxContextMenu } from 'devextreme-vue/context-menu';
  
  export default {
      components: {
          DxContextMenu
      },
      data() {
          const serviceUrl = "https://url/to/my/service";
          const store = createStore({
              key: "ID",
              loadUrl: serviceUrl + "/GetAction",
              insertUrl: serviceUrl + "/InsertAction",
              updateUrl: serviceUrl + "/UpdateAction",
              deleteUrl: serviceUrl + "/DeleteAction"
          });
          return {
              store
          }
      }
  }
  </script>

  React

  import React from 'react';
  import 'devextreme/dist/css/dx.light.css';
  
  import CustomStore from 'devextreme/data/custom_store';
  import { createStore } from 'devextreme-aspnet-data-nojquery';
  import ContextMenu from 'devextreme-react/context-menu';
  
  const serviceUrl = "https://url/to/my/service";
  const store = createStore({
      key: "ID",
      loadUrl: serviceUrl + "/GetAction",
      insertUrl: serviceUrl + "/InsertAction",
      updateUrl: serviceUrl + "/UpdateAction",
      deleteUrl: serviceUrl + "/DeleteAction"
  });
  
  class App extends React.Component {
      render() {
          return (
              <ContextMenu ...
                  dataSource={store} />
          );
      }
  }
  export default App;

• Any other data source
  Implement a CustomStore.

Regardless of the data source on the input, the ContextMenu 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:

• Do not specify the items property if you specified the dataSource, and vice versa.

• Field names cannot be equal to this and should not contain the following characters: ., :, [, and ].

• ContextMenu does not execute dataSource.sort functions. To implement custom sorting logic, implement columns[].calculateSortValue.

• The stores are immutable. You cannot change their configurations at runtime. Instead, create a new store or DataSource and assign it to the dataSource property as shown in the following help topic: Get and Set Properties.

• The stores are immutable. You cannot change their configurations at runtime. Instead, create a new store or DataSource and assign it to the dataSource property as shown in the following help topic: Two-Way Property Binding.

• The stores are immutable. You cannot change their configurations at runtime. Instead, create a new store or DataSource and assign it to the dataSource property as shown in the following help topic: Two-Way Property Binding.

• The stores are immutable. You cannot change their configurations at runtime. Instead, create a new store or DataSource and assign it to the dataSource property as shown in the following help topic: Controlled Mode.

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

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: {}

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

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

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

<template>
    <DxContextMenu ...
        :element-attr="contextMenuAttributes">
    </DxContextMenu>
</template>

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

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

import React from 'react';

import ContextMenu from 'devextreme-react/context-menu';

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

    render() {
        return (
            <ContextMenu ...
                elementAttr={this.contextMenuAttributes}>
            </ContextMenu>
        );
    }
}
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 whether to hide the UI component if a user clicks outside it.

Selector: hide-on-outside-click

true if the UI component should be hidden; otherwise false.

Default Value: true

The function passed to this property enables you to specify a custom condition for UI component hiding. For instance, you can prevent hiding until a user clicks a certain element.

$(function () {
    $("#contextMenuContainer").dxContextMenu({
        // ...
        hideOnOutsideClick: function(e) {
            return e.target === $("#someElement").get()[0];
        }
    });
});

import { DxContextMenuModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
    hideOnOutsideClick(e) {
        return e.target === document.getElementById("someElement");
    }
}
@NgModule({
     imports: [
         // ...
         DxContextMenuModule
     ],
     // ...
 })

<dx-context-menu ...
    [hideOnOutsideClick]="hideOnOutsideClick">
</dx-context-menu>

<template>
    <DxContextMenu ....
        :hide-on-outside-click="hideOnOutsideClick">
    </DxContextMenu>
</template>

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

import DxContextMenu from 'devextreme-vue/context-menu';

export default {
    components: {
        DxContextMenu
    },
    methods: {
        hideOnOutsideClick (e) {
            return e.target === document.getElementById("someElement");
        }
    }
}
</script>

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

import ContextMenu from 'devextreme-react/context-menu';

const hideOnOutsideClick = (e) => {
    return e.target === document.getElementById("someElement");
};

export default function App() {
    return (
        <ContextMenu ...
            hideOnOutsideClick={hideOnOutsideClick}>
        </ContextMenu>
    );
}

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:

• Objects with fields described in this section
• Objects with any other fields. In this case, specify the itemTemplate.

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

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

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

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 after the ContextMenu is hidden.

Selector: @hidden

Information about the event.

Object structure:

Default Value: null

A function that is executed before the ContextMenu is hidden.

Selector: @hiding

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

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

App.vue (Composition API)

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

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

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

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

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

let contextMenuInstance = null;

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

import ContextMenu from 'devextreme-react/context-menu';

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

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

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

    render() {
        return (
            <div>
                <ContextMenu 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 when a collection item is clicked or tapped.

Selector: @item-click

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

Information about the event.

Object structure:

Default Value: null

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

Selector: @item-rendered

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.

ContextMenu

The UI component's instance.

Default Value: null

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

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

<dx-context-menu ...
    (onOptionChanged)="handlePropertyChange($event)"> 
</dx-context-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 { DxContextMenuModule } from 'devextreme-angular'; 

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

export class AppModule { }  

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

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

export default { 
    components: { 
        DxContextMenu
    }, 
    // ...
    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 ContextMenu from 'devextreme-react/context-menu'; 

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

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

A function that is executed before the ContextMenu is positioned.

Selector: @positioning

Information about the event.

Object structure:

Default Value: null

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

Selector: @selection-changed

Information about the event.

Object structure:

Default Value: null

A function that is executed before the ContextMenu is shown.

Selector: @showing

Information about the event.

Object structure:

Default Value: null

A function that is executed after the ContextMenu is shown.

Selector: @shown

Information about the event.

Object structure:

Default Value: null

An object defining UI component positioning properties.

Selector: DxPosition

Default Value: { my: 'top left', at: 'top left' }

By default, the context menu is positioned against the cursor, but if you set the

property, the UI component will be positioned against the

element. Note also that the

.

property is always ignored in favor of the

property.

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 used to display the UI component.

Selector: DxShowEvent

Default Value: 'dxcontextmenu'

If you assign only a string that specifies event names on which the UI component is shown, the UI component will not apply a delay.

Assign "" (an empty string) to showEvent if you want to display the component only through code (for instance, by calling the show() method).

Specifies properties of submenu showing and hiding.

Selector: DxShowSubmenuMode

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

Specifies the direction at which submenus are displayed.

Selector: submenu-direction

Default Value: 'auto'

By default, the submenus of the context menu are displayed so that they are visible totally, based on the UI component location on the page. Use the submenuDirection property to display submenus to the left or to the right from the context menu.

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 target element associated with the context menu.

This property accepts one of the following values:

• A jQuery selector

  $(function(){
      $("#contextMenuContainer").dxContextMenu({
          // ...
          target: '#targetElement'
      });
  });

• A jQuery wrapper

  $(function(){
      $("#contextMenuContainer").dxContextMenu({
          // ...
          target: $('#targetElement')
      });
  });

• A DOM element

  $(function(){
      $("#contextMenuContainer").dxContextMenu({
          // ...
          target: document.getElementById('#targetElement')
      });
  });

• A CSS selector

  <dx-context-menu ... 
      target="#targetElement"
  >
  </dx-context-menu>

  The component supports only valid CSS identifiers. To target elements with invalid identifiers, specify an attribute selector instead.

  <dx-context-menu ... 
      target="#111" // An invalid CSS identifier
  >
  </dx-context-menu>
  <dx-context-menu ... 
      target="[id='#111']" // An attribute selector
  >
  </dx-context-menu>

• A DOM element

  <dx-context-menu ... 
      [target]="targetElement"
  >
  </dx-context-menu>

  // ...
  export class AppComponent {
      targetElement: Element;
      constructor() {
          this.targetElement = document.getElementById('#targetElement') as Element;
      }
  }

• A CSS selector

  <template>
      <DxContextMenu ... 
          target="#targetElement"
      >
      </DxContextMenu>
  </template>
  <script setup lang="ts">
  import { DxContextMenu } from 'devextreme-vue/context-menu';
  </script>

  The component supports only valid CSS identifiers. To target elements with invalid identifiers, specify an attribute selector instead.

  <template>
      <DxContextMenu ... 
          target="#111" // An invalid CSS identifier
      >
      </DxContextMenu>
      <DxContextMenu ... 
          target="[id='#111']" // An attribute selector
      >
      </DxContextMenu>
  </template>

• A DOM element

  <template>
      <DxContextMenu ... 
          :target="targetElement"
      >
      </DxContextMenu>
  </template>
  <script>
  import { DxContextMenu } from 'devextreme-vue/context-menu';
  
  export default {
      components: {
          DxContextMenu
      },
      data() {
          return {
              targetElement: null
          }
      },
      mounted() {
          this.targetElement = document.getElementById('targetElement');
      }
  };
  </script>

• A CSS selector

  import ContextMenu from 'devextreme-react/context-menu';
  // ...
  function App() {
      return (
          <ContextMenu ... 
              target="#targetElement"
          >
          </ContextMenu>
      );
  }

  The component supports only valid CSS identifiers. To target elements with invalid identifiers, specify an attribute selector instead.

  import ContextMenu from 'devextreme-react/context-menu';
  // ...
  function App() {
      return (
          <ContextMenu ... 
              target="#111" // An invalid CSS identifier
          >
          </ContextMenu>
          <ContextMenu ... 
              target="[id='#111']" // An attribute selector
          >
          </ContextMenu>
      );
  }

• A DOM element

  import React, { useEffect, useState } from 'react';
  import ContextMenu from 'devextreme-react/context-menu';
  // ...
  function App() {
      const [targetElement, setTargetElement] = useState(null);
      useEffect(() => {
          setTargetElement(document.getElementById('targetElement'));
      }, []);
      return (
          <ContextMenu ... 
              target={targetElement}
          >
          </ContextMenu>
      );
  }

Target type affects the initialization of the component's events:

• undefined
  Events are initialized on the document.
• Selector
  Events are initialized on the document with the passed selector.
• jQuery wrapper or DOM element
  Events are initialized on the passed element.

This changes event propagation and the behavior of methods like stopPropagation().

Target type affects the initialization of the component's events:

• undefined
  Events are initialized on the document.
• Selector
  Events are initialized on the document with the passed selector.
• DOM element
  Events are initialized on the passed element.

This changes event propagation and the behavior of methods like stopPropagation().

Target type affects the initialization of the component's events:

• undefined
  Events are initialized on the document.
• Selector
  Events are initialized on the document with the passed selector.
• DOM element
  Events are initialized on the passed element.

This changes event propagation and the behavior of methods like stopPropagation().

Target type affects the initialization of the component's events:

• undefined
  Events are initialized on the document.
• Selector
  Events are initialized on the document with the passed selector.
• DOM element
  Events are initialized on the passed element.

This changes event propagation and the behavior of methods like stopPropagation().

To align the ContextMenu against this element, use the position property.

When target is undefined and showEvent is related to mouse/touch inputs (the default dxcontextmenu event), the component is displayed at the mouse cursor/touch location. If the showEvent value is not related to mouse/touch events, the component is displayed in the top-left corner of the page.

A Boolean value specifying whether or not the UI component is visible.

Use this property to display/hide a context menu in code.

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