331 lines
12 KiB
Vue
Executable File
331 lines
12 KiB
Vue
Executable File
<template>
|
|
<AppDoc name="TooltipDemo" :sources="sources" github="tooltip/TooltipDemo.vue">
|
|
<h5>Getting Started</h5>
|
|
<p>Tooltip is a directive that needs to be imported and configured with a name of your choice. Global configuration is done with the <i>app.directive</i> function.</p>
|
|
<pre v-code.script><code>
|
|
import Tooltip from 'primevue/tooltip';
|
|
|
|
app.directive('tooltip', Tooltip);
|
|
|
|
</code></pre>
|
|
|
|
<h5>Import via CDN</h5>
|
|
<pre v-code><code>
|
|
<script src="https://unpkg.com/primevue@^3/core/core.min.js"></script>
|
|
|
|
</code></pre>
|
|
|
|
<p>Tooltip can also be configured locally using the directives property of your component.</p>
|
|
<pre v-code.script><code>
|
|
directives: {
|
|
'tooltip': Tooltip
|
|
}
|
|
|
|
</code></pre>
|
|
|
|
<p>Once the tooltip is configured, it can be attached to a target using the v- prefix.</p>
|
|
<pre v-code><code><template v-pre>
|
|
<InputText type="text" v-tooltip="'Enter your username'" />
|
|
</template>
|
|
</code></pre>
|
|
|
|
<p>Also, more than one value can be used.</p>
|
|
<pre v-code><code><template v-pre>
|
|
<InputText type="text" v-tooltip="{ value: 'Enter your username', disabled: true }" />
|
|
</template>
|
|
</code></pre>
|
|
|
|
<h5>Positions</h5>
|
|
<p>There are four choices to position the tooltip, default value is "right" and alternatives are "top", "bottom", "left". Position is specified using a modifier.</p>
|
|
<pre v-code><code><template v-pre>
|
|
<InputText type="text" v-tooltip.right="'Enter your username'" />
|
|
<InputText type="text" v-tooltip.top="'Enter your username'" />
|
|
<InputText type="text" v-tooltip.bottom="'Enter your username'" />
|
|
<InputText type="text" v-tooltip.left="'Enter your username'" />
|
|
</template>
|
|
</code></pre>
|
|
|
|
<h5>Events</h5>
|
|
<p>Tooltip gets displayed on hover event of its target by default, other option is the focus event to display and blur to hide.</p>
|
|
<pre v-code><code><template v-pre>
|
|
<InputText type="text" v-tooltip.focus="'Enter your username'" />
|
|
</template>
|
|
</code></pre>
|
|
|
|
<h5>Modifiers</h5>
|
|
<p>As seen in positions and event sections, tooltip is configured via modifiers that can be chained. Tooltip below, gets displayed at the top of the input at focus event.</p>
|
|
<pre v-code><code><template v-pre>
|
|
<InputText type="text" v-tooltip.top.focus="'Enter your username'" />
|
|
</template>
|
|
</code></pre>
|
|
|
|
<h5>Properties</h5>
|
|
<div class="doc-tablewrapper">
|
|
<table class="doc-table">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Default</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>value</td>
|
|
<td>string</td>
|
|
<td>null</td>
|
|
<td>Text of the tooltip</td>
|
|
</tr>
|
|
<tr>
|
|
<td>disabled</td>
|
|
<td>boolean</td>
|
|
<td>false</td>
|
|
<td>When present, it specifies that the component should be disabled.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>id</td>
|
|
<td>string</td>
|
|
<td>null</td>
|
|
<td>When present, it adds a custom id to the tooltip.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>class</td>
|
|
<td>string</td>
|
|
<td>null</td>
|
|
<td>When present, it adds a custom class to the tooltip.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>escape</td>
|
|
<td>boolean</td>
|
|
<td>false</td>
|
|
<td>By default the tooltip contents are not rendered as text. Set to true to support html tags in the content.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>fitContent</td>
|
|
<td>boolean</td>
|
|
<td>true</td>
|
|
<td>Automatically adjusts the element position when there is not enough space on the selected position.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<h5>Styling</h5>
|
|
<p>Following is the list of structural style classes, for theming classes visit <router-link to="/theming">theming</router-link> page.</p>
|
|
<div class="doc-tablewrapper">
|
|
<table class="doc-table">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Element</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>p-tooltip</td>
|
|
<td>Input element.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>p-tooltip-arrow</td>
|
|
<td>Arrow of the tooltip.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>p-tooltip-text</td>
|
|
<td>Text of the tooltip</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<h5>Accessibility</h5>
|
|
<h6>Screen Reader</h6>
|
|
<p>Tooltip component uses <i>tooltip</i> role and when it becomes visible the generated id of the tooltip is defined as the <i>aria-describedby</i> of the target.</p>
|
|
|
|
<h6>Keyboard Support</h6>
|
|
<div class="doc-tablewrapper">
|
|
<table class="doc-table">
|
|
<thead>
|
|
<tr>
|
|
<th>Key</th>
|
|
<th>Function</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<i>escape</i>
|
|
</td>
|
|
<td>Closes the tooltip when focus is on the target.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<h5>Dependencies</h5>
|
|
<p>None.</p>
|
|
</AppDoc>
|
|
</template>
|
|
|
|
<script>
|
|
export default {
|
|
data() {
|
|
return {
|
|
sources: {
|
|
'options-api': {
|
|
tabName: 'Options API Source',
|
|
content: `
|
|
<template>
|
|
<div>
|
|
<h5>Positions</h5>
|
|
<div class="grid p-fluid">
|
|
<div class="col-12 md:col-3">
|
|
<InputText type="text" placeholder="Right" v-tooltip.right="'Enter your username'" />
|
|
</div>
|
|
<div class="col-12 md:col-3">
|
|
<InputText type="text" placeholder="Top" v-tooltip.top="'Enter your username'" />
|
|
</div>
|
|
<div class="col-12 md:col-3">
|
|
<InputText type="text" placeholder="Bottom" v-tooltip.bottom="'Enter your username'" />
|
|
</div>
|
|
<div class="col-12 md:col-3">
|
|
<InputText type="text" placeholder="Left" v-tooltip.left="'Enter your username'" />
|
|
</div>
|
|
</div>
|
|
|
|
<h5>Focus and Blur</h5>
|
|
<InputText type="text" placeholder="Focus" v-tooltip.bottom.focus="'Enter your username'" />
|
|
|
|
<h5>Button</h5>
|
|
<Button type="button" label="Save" icon="pi pi-check" v-tooltip="'Click to proceed'" />
|
|
|
|
<h5>Custom Class</h5>
|
|
<InputText type="text" placeholder="Custom Class" v-tooltip.right="{value:'Invalid username', class: 'custom-error'}" />
|
|
</div>
|
|
</template>
|
|
|
|
<script>
|
|
export default {
|
|
}
|
|
<\\/script>
|
|
<style>
|
|
.custom-error .p-tooltip-text {
|
|
background-color: var(--pink-800);
|
|
color: rgb(255, 255, 255);
|
|
}
|
|
.custom-error.p-tooltip-right .p-tooltip-arrow {
|
|
border-right-color: var(--pink-800);
|
|
}
|
|
</style>
|
|
`
|
|
},
|
|
'composition-api': {
|
|
tabName: 'Composition API Source',
|
|
content: `
|
|
<template>
|
|
<div>
|
|
<h5>Positions</h5>
|
|
<div class="grid p-fluid">
|
|
<div class="col-12 md:col-3">
|
|
<InputText type="text" placeholder="Right" v-tooltip.right="'Enter your username'" />
|
|
</div>
|
|
<div class="col-12 md:col-3">
|
|
<InputText type="text" placeholder="Top" v-tooltip.top="'Enter your username'" />
|
|
</div>
|
|
<div class="col-12 md:col-3">
|
|
<InputText type="text" placeholder="Bottom" v-tooltip.bottom="'Enter your username'" />
|
|
</div>
|
|
<div class="col-12 md:col-3">
|
|
<InputText type="text" placeholder="Left" v-tooltip.left="'Enter your username'" />
|
|
</div>
|
|
</div>
|
|
|
|
<h5>Focus and Blur</h5>
|
|
<InputText type="text" placeholder="Focus" v-tooltip.bottom.focus="'Enter your username'" />
|
|
|
|
<h5>Button</h5>
|
|
<Button type="button" label="Save" icon="pi pi-check" v-tooltip="'Click to proceed'" />
|
|
|
|
<h5>Custom Class</h5>
|
|
<InputText type="text" placeholder="Custom Class" v-tooltip.right="{value:'Invalid username', class: 'custom-error'}" />
|
|
</div>
|
|
</template>
|
|
|
|
<script>
|
|
export default {
|
|
}
|
|
<\\/script>
|
|
<style>
|
|
.custom-error .p-tooltip-text {
|
|
background-color: var(--pink-800);
|
|
color: rgb(255, 255, 255);
|
|
}
|
|
.custom-error.p-tooltip-right .p-tooltip-arrow {
|
|
border-right-color: var(--pink-800);
|
|
}
|
|
</style>
|
|
`
|
|
},
|
|
'browser-source': {
|
|
tabName: 'Browser Source',
|
|
content: `<div id="app">
|
|
<h5>Positions</h5>
|
|
<div class="grid p-fluid">
|
|
<div class="col-12 md:col-3">
|
|
<p-inputtext type="text" placeholder="Right" v-tooltip.right="'Enter your username'"></p-inputtext>
|
|
</div>
|
|
<div class="col-12 md:col-3">
|
|
<p-inputtext type="text" placeholder="Top" v-tooltip.top="'Enter your username'"></p-inputtext>
|
|
</div>
|
|
<div class="col-12 md:col-3">
|
|
<p-inputtext type="text" placeholder="Bottom" v-tooltip.bottom="'Enter your username'"></p-inputtext>
|
|
</div>
|
|
<div class="col-12 md:col-3">
|
|
<p-inputtext type="text" placeholder="Left" v-tooltip.left="'Enter your username'"></p-inputtext>
|
|
</div>
|
|
</div>
|
|
|
|
<h5>Focus and Blur</h5>
|
|
<p-inputtext type="text" placeholder="Focus" v-tooltip.bottom.focus="'Enter your username'"></p-inputtext>
|
|
|
|
<h5>Button</h5>
|
|
<p-button type="button" label="Save" icon="pi pi-check" v-tooltip="'Click to proceed'"></p-button>
|
|
|
|
<h5>Custom Class</h5>
|
|
<p-inputtext type="text" placeholder="Custom Class" v-tooltip.right="{value:'Invalid username', class: 'custom-error'}"></p-inputtext>
|
|
</div>
|
|
|
|
<script type="module">
|
|
const { createApp } = Vue;
|
|
const Tooltip = primevue.tooltip;
|
|
|
|
const App = {
|
|
components: {
|
|
"p-inputtext": primevue.inputtext,
|
|
"p-button": primevue.button
|
|
}
|
|
};
|
|
|
|
createApp(App)
|
|
.use(primevue.config.default)
|
|
.directive("tooltip", Tooltip)
|
|
.mount("#app");
|
|
<\\/script>
|
|
|
|
<style>
|
|
.custom-error .p-tooltip-text {
|
|
background-color: var(--pink-800);
|
|
color: rgb(255, 255, 255);
|
|
}
|
|
.custom-error.p-tooltip-right .p-tooltip-arrow {
|
|
border-right-color: var(--pink-800);
|
|
}
|
|
</style>
|
|
`
|
|
}
|
|
}
|
|
};
|
|
}
|
|
};
|
|
</script>
|