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

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

Vue Tooltip Props | Vue Documentation

An object defining configuration properties for the Tooltip UI component.

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

The following code specifies the default value of the object:

{
    show: {
        type: 'fade',
        from: 0,
        to: 1
    },
    hide: {
        type: 'fade',
        from: 1,
        to: 0
    }
}

Set this object to null or undefined to disable animations.

Specifies the container in which to render the UI component.

This property accepts one of the following values:

• A CSS selector, or a jQuery selector if you use jQuery

  jQuery

  $(function(){
      $("#tooltipContainer").dxTooltip({
          // ...
          container: '#containerElement'
      });
  });

  Angular

  <dx-tooltip ... 
      container="#containerElement"
  >
  </dx-tooltip>

  Vue

  <template>
      <DxTooltip ... 
          container="#containerElement"
      >
      </DxTooltip>
  </template>
  <script>
  import { DxTooltip } from 'devextreme-vue/tooltip';
  
  export default {
      components: {
          DxTooltip
      }
  };
  </script>

  React

  import Tooltip from 'devextreme-react/tooltip';
  // ...
  function App() {
      return (
          <Tooltip ... 
              container="#containerElement"
          >
          </Tooltip>
      );
  }

• A jQuery wrapper

  jQuery

  $(function(){
      $("#tooltipContainer").dxTooltip({
          // ...
          container: $('#containerElement')
      });
  });

• A DOM element

  jQuery

  $(function(){
      $("#tooltipContainer").dxTooltip({
          // ...
          container: document.getElementById('#containerElement')
      });
  });

  Angular

  <dx-tooltip ... 
      [container]="containerElement"
  >
  </dx-tooltip>

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

  Vue

  <template>
      <DxTooltip ... 
          :container="containerElement"
      >
      </DxTooltip>
  </template>
  <script>
  import { DxTooltip } from 'devextreme-vue/tooltip';
  
  export default {
      components: {
          DxTooltip
      },
      data() {
          return {
              containerElement: null
          }
      },
      mounted() {
          this.containerElement = document.getElementById('containerElement');
      }
  };
  </script>

  React

  import React, { useEffect, useState } from 'react';
  import Tooltip from 'devextreme-react/tooltip';
  // ...
  function App() {
      const [containerElement, setContainerElement] = useState(null);
      useEffect(() => {
          setContainerElement(document.getElementById('containerElement'));
      }, []);
      return (
          <Tooltip ... 
              container={containerElement}
          >
          </Tooltip>
      );
  }

The UI component defines the default container on its initialization. This default container can be one of the following (if the element is absent, the component selects the next one):

• color swatch container

• .dx-viewport

• body

Specifies a custom template for the UI component content.

Selector: content-template

Default Name: 'content'

Specifies whether to render the UI component'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.

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 Tooltip calculates its height relative to the window.

Specifies properties of popover hiding. Ignored if the shading property is set to true.

Selector: DxHideEvent

Default Value: undefined

The target property specifies a target element for the Tooltip hideEvent.

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

Specifies whether to hide the UI component if a user clicks outside the popover window or outside the target element.

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 () {
    $("#tooltipContainer").dxTooltip({
        // ...
        hideOnOutsideClick: function(e) {
            return e.target === $("#someElement").get()[0];
        }
    });
});

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

<dx-tooltip ...
    [hideOnOutsideClick]="hideOnOutsideClick">
</dx-tooltip>

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

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

import DxTooltip from 'devextreme-vue/tooltip';

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

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

import Tooltip from 'devextreme-react/tooltip';

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

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

The hideOnOutsideClick function is called when a user clicks the UI component or outside it.

Popup Demo

Specifies whether to hide the Tooltip when users scroll one of its parent elements.

Selector: hide-on-parent-scroll

Default Value: true

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

Specifies the maximum height the UI component can reach while resizing.

Selector: max-height

Default Value: null

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 the maximum width the UI component can reach while resizing.

Selector: max-width

Default Value: null

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

Specifies the minimum height the UI component can reach while resizing.

Selector: min-height

Default Value: null

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 the minimum width the UI component can reach while resizing.

Selector: min-width

Default Value: null

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

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 UI component is hidden.

Selector: @hidden

Information about the event.

Object structure:

Default Value: null

A function that is executed before the UI component 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-tooltip ...
    (onInitialized)="saveInstance($event)">
</dx-tooltip>

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

App.vue (Composition API)

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

<script>
import DxTooltip from 'devextreme-vue/tooltip';

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

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

<script setup>
import DxTooltip from 'devextreme-vue/tooltip';

let tooltipInstance = null;

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

import Tooltip from 'devextreme-react/tooltip';

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

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

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

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

Tooltip

The UI component's instance.

Default Value: null

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

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

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

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

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

export class AppModule { }  

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

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

export default { 
    components: { 
        DxTooltip
    }, 
    // ...
    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 Tooltip from 'devextreme-react/tooltip'; 

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

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

A function that is executed before the UI component is displayed.

Selector: @showing

Information about the event.

Object structure:

HTMLElement | jQuery

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

Tooltip

The UI component's instance.

Boolean

Set this field to true if you want to prevent the Tooltip from being displayed.

Default Value: null

A function that is executed after the UI component is displayed.

Selector: @shown

Information about the event.

Object structure:

Default Value: null

An object defining UI component positioning properties.

Selector: DxPosition

Default Value: { my: 'top center', at: 'bottom center', collision: 'fit flip' }

You can use the position.of property and the Popover's target property to specify the element against which the UI component will be positioned. If you set both these properties, position.of takes precedence.

Besides the position configuration object, the property can take on the following string values, which are shortcuts for the corresponding position configuration.

• "top" - places the popover over the target element
• "bottom" - places the popover under the target element
• "left" - places the popover to the left of the target element
• "right" - places the popover to the right of the target element

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 shade the background when the UI component is active.

Shading always applies to the window.

Specifies the shading color. Applies only if shading is enabled.

Selector: shading-color

Default Value: ''

Specifies properties for displaying the UI component.

Selector: DxShowEvent

Default Value: undefined

The target property specifies a target element for the Tooltip showEvent.

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

Specifies the element against which to position the Tooltip. If target is undefined, the component cannot be displayed.

This property accepts one of the following values:

• A jQuery selector

  $(function(){
      $("#tooltipContainer").dxTooltip({
          // ...
          target: '#targetElement'
      });
  });

• A jQuery wrapper

  $(function(){
      $("#tooltipContainer").dxTooltip({
          // ...
          target: $('#targetElement')
      });
  });

• A DOM element

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

• A CSS selector

  <dx-tooltip ... 
      target="#targetElement"
  >
  </dx-tooltip>

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

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

• A DOM element

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

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

• A CSS selector

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

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

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

• A DOM element

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

• A CSS selector

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

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

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

• A DOM element

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

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 change the Tooltip position against this element, use the position property.

This property also specifies a target element for the Tooltip showEvent and hideEvent.

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

Popup Demo

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

The Tooltip calculates its width relative to the window.

Specifies the global attributes for the UI component's wrapper element.

Selector: wrapper-attr

Type: any

Default Value: {}

$(function(){
    $("#tooltipContainer").dxTooltip({
        // ...
        wrapperAttr: {
            id: "elementId",
            class: "class-name"
        }
    });
});

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

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

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

import { DxTooltipModule } from 'devextreme-angular';

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

<template>
    <DxTooltip ...
        :wrapper-attr="tooltipAttributes">
    </DxTooltip>
</template>

<script>
import DxTooltip from 'devextreme-vue/tooltip';

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

import React, { useMemo } from 'react';

import Tooltip from 'devextreme-react/tooltip';

function App() {
    const tooltipAttributes = useMemo(() => {
        return {
            id: 'elementId',
            class: 'class-name'
        }
    }, []);

    return (
        <Tooltip ...
            wrapperAttr={tooltipAttributes}>
        </Tooltip>
    );
}
export default App;

The code above specifies the id and class attributes for the wrapper element and produces markup similar to this:

<body>
    <!-- The following is the wrapper element. -->
    <!-- It is nested inside an element defined by the `container` property (`<body>` by default). -->
    <div id="elementId" class="dx-overlay-wrapper dx-tooltip-wrapper class-name" ... > 

        <!-- The following element contains component content. -->
        <div class="dx-overlay-content" ... >

            <!-- The following element displays content specified in the `contentTemplate`. -->
            <div class="dx-popup-content" ... >
                <!-- ... -->
            </div>
        </div>
    </div>
</body>

You can specify attributes to the component's root element directly in HTML code:

<div id="myTooltip" class="myClass"></div>

You can specify attributes to the component's root element directly in HTML code:

<dx-tooltip ... class="myClass">
</dx-tooltip>

You can specify attributes to the component's root element directly in HTML code:

<Tooltip ... className="myClass" />

To add an attribute to an ASP.NET Core control, use its OnInitialized method:

@(Html.DevExtreme().Tooltip()...
    .OnInitialized("(e) => e.element.addClass('myClass')")
)

To add an attribute to an ASP.NET MVC control, use its OnInitialized method:

    @(Html.DevExtreme().Tooltip()...
    .OnInitialized("(e) => e.element.addClass('myClass')")
)

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