primevue-mirror/pages/tabmenu/TabMenuDoc.vue

<template>
    <ClientOnly
        ><AppDoc name="TabMenuDemo" :sources="sources" :extPages="pages" github="tabmenu/TabMenuDemo.vue">
            <h5>Import via Module</h5>
            <pre v-code.script><code>
import TabMenu from 'primevue/tabmenu';

</code></pre>

            <h5>Import via CDN</h5>
            <pre v-code><code>
&lt;script src="https://unpkg.com/primevue@^3/core/core.min.js"&gt;&lt;/script&gt;
&lt;script src="https://unpkg.com/primevue@^3/tabmenu/tabmenu.min.js"&gt;&lt;/script&gt;

</code></pre>

            <h5>MenuModel</h5>
            <p>TabMenu uses the common MenuModel API to define the items, visit <router-link to="/menumodel">MenuModel API</router-link> for details.</p>

            <h5>Getting Started</h5>
            <p>TabMenu requires a collection of menuitems as its model.</p>
            <pre v-code><code>
&lt;TabMenu :model="items" /&gt;

</code></pre>

            <pre v-code.script><code>
export default {
	data() {
		return {
			items: [
                {label: 'Home', icon: 'pi pi-fw pi-home'},
                {label: 'Calendar', icon: 'pi pi-fw pi-calendar'},
                {label: 'Edit', icon: 'pi pi-fw pi-pencil'},
                {label: 'Documentation', icon: 'pi pi-fw pi-file'},
                {label: 'Settings', icon: 'pi pi-fw pi-cog'}
            ]
		}
	}
}

</code></pre>

            <p>TabMenu can be also integrated with Vue Router.</p>
            <pre v-code><code>
&lt;TabMenu :model="items" /&gt;
&lt;router-view /&gt;

</code></pre>

            <pre v-code.script><code>
export default {
	data() {
		return {
			items: [
                {label: 'Home', icon: 'pi pi-fw pi-home', to: '/tabmenu'},
                {label: 'Calendar', icon: 'pi pi-fw pi-calendar', to: '/tabmenu/calendar'},
                {label: 'Edit', icon: 'pi pi-fw pi-pencil', to: '/tabmenu/edit'},
                {label: 'Documentation', icon: 'pi pi-fw pi-file', to: '/tabmenu/documentation'},
                {label: 'Settings', icon: 'pi pi-fw pi-cog', to: '/tabmenu/settings'}
            ]
		}
	}
}

</code></pre>

            <h5>Active</h5>
            <p>Visibility of the content is specified with the activeIndex property that supports one or two-way binding.</p>

            <pre v-code><code>
&lt;TabMenu :model="items" :activeIndex="activeIndex" /&gt;

</code></pre>

            <p>Two-way binding requires v-model.</p>
            <pre v-code><code>
&lt;TabMenu :model="items" v-model:activeIndex="activeIndex" /&gt;

</code></pre>

            <h5>Templating</h5>
            <p>TabMenu offers content customization with the <i>item</i> template that receives the menuitem instance from the model as a parameter.</p>
            <pre v-code><code><template v-pre>
&lt;TabMenu :model="items"&gt;
    &lt;template #item="{item}"&gt;
        &lt;a :href="item.url"&gt;{{item.label}}&lt;/a&gt;
    &lt;/template&gt;
&lt;/TabMenu&gt;
</template>
</code></pre>

            <h5>Properties</h5>
            <p>Any property as style and class are passed to the main container element. Following are the additional properties to configure the component.</p>
            <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>model</td>
                            <td>array</td>
                            <td>null</td>
                            <td>An array of menuitems.</td>
                        </tr>
                        <tr>
                            <td>exact</td>
                            <td>boolean</td>
                            <td>true</td>
                            <td>Defines if active route highlight should match the exact route path.</td>
                        </tr>
                        <tr>
                            <td>activeIndex</td>
                            <td>number</td>
                            <td>0</td>
                            <td>Active index of menuitem.</td>
                        </tr>
                    </tbody>
                </table>
            </div>

            <h5>Events</h5>
            <div class="doc-tablewrapper">
                <table class="doc-table">
                    <thead>
                        <tr>
                            <th>Name</th>
                            <th>Parameters</th>
                            <th>Description</th>
                        </tr>
                    </thead>
                    <tbody>
                        <tr>
                            <td>tab-change</td>
                            <td>
                                event.originalEvent: Browser event <br />
                                event.index: Index of the selected tab
                            </td>
                            <td>Callback to invoke when an active tab is changed.</td>
                        </tr>
                    </tbody>
                </table>
            </div>

            <h5>Slots</h5>
            <div class="doc-tablewrapper">
                <table class="doc-table">
                    <thead>
                        <tr>
                            <th>Name</th>
                            <th>Parameters</th>
                        </tr>
                    </thead>
                    <tbody>
                        <tr>
                            <td>item</td>
                            <td>item: Menuitem instance</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-tabmenu</td>
                            <td>Container element.</td>
                        </tr>
                        <tr>
                            <td>p-tabmenu-nav</td>
                            <td>List element.</td>
                        </tr>
                        <tr>
                            <td>p-tabmenuitem</td>
                            <td>Menuitem element.</td>
                        </tr>
                        <tr>
                            <td>p-menuitem-link</td>
                            <td>Link element of the menuitem.</td>
                        </tr>
                        <tr>
                            <td>p-menuitem-icon</td>
                            <td>Icon of a menuitem.</td>
                        </tr>
                        <tr>
                            <td>p-menuitem-text</td>
                            <td>Text of a menuitem.</td>
                        </tr>
                    </tbody>
                </table>
            </div>

            <h5>Accessibility</h5>

            <h6>Screen Reader</h6>
            <p>
                TabMenu component uses the <i>menubar</i> role and the value to describe the menu can either be provided with <i>aria-labelledby</i> or <i>aria-label</i> props. Each list item has a <i>presentation</i> role whereas anchor elements
                have a <i>menuitem</i> role with <i>aria-label</i> referring to the label of the item and <i>aria-disabled</i> defined if the item is disabled.
            </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>tab</i>
                            </td>
                            <td>Adds focus to the active tab header when focus moves in to the component, if there is already a focused tab header moves the focus out of the component based on the page tab sequence.</td>
                        </tr>
                        <tr>
                            <td>
                                <i>enter</i>
                            </td>
                            <td>Activates the focused tab header.</td>
                        </tr>
                        <tr>
                            <td>
                                <i>space</i>
                            </td>
                            <td>Activates the focused tab header.</td>
                        </tr>
                        <tr>
                            <td>
                                <i>right arrow</i>
                            </td>
                            <td>Moves focus to the next header.</td>
                        </tr>
                        <tr>
                            <td>
                                <i>left arrow</i>
                            </td>
                            <td>Moves focus to the previous header.</td>
                        </tr>
                        <tr>
                            <td>
                                <i>home</i>
                            </td>
                            <td>Moves focus to the first header.</td>
                        </tr>
                        <tr>
                            <td>
                                <i>end</i>
                            </td>
                            <td>Moves focus to the last header.</td>
                        </tr>
                    </tbody>
                </table>
            </div>

            <h5>Dependencies</h5>
            <p>None.</p>
        </AppDoc></ClientOnly
    >
</template>

<script>
export default {
    data() {
        return {
            sources: {
                'options-api': {
                    tabName: 'Options API Source',
                    content: `
<template>
    <div>
        <div class="card">
            <h5>Default</h5>
            <TabMenu :model="items" />
            <router-view/>
        </div>

        <div class="card">
            <h5>Programmatic</h5>
            <div class="py-2">
                <Button @click="active = 0" class="p-button-text" label="Activate 1st" />
                <Button @click="active = 1" class="p-button-text mr-2" label="Activate 2nd" />
                <Button @click="active = 2" class="p-button-text mr-2" label="Activate 3rd" />
            </div>

            <TabMenu :model="items2" v-model:activeIndex="active" />
        </div>
    </div>
</template>

<script>
export default {
    data() {
        return {
            active: 3,
            items: [
                {
                    label: 'Home',
                    icon: 'pi pi-fw pi-home',
                    to: '/'
                },
                {
                    label: 'Calendar',
                    icon: 'pi pi-fw pi-calendar',
                    to: '/calendar'
                },
                {
                    label: 'Edit',
                    icon: 'pi pi-fw pi-pencil',
                    to: '/edit'
                },
                {
                    label: 'Documentation',
                    icon: 'pi pi-fw pi-file',
                    to: '/documentation'
                },
                {
                    label: 'Settings',
                    icon: 'pi pi-fw pi-cog',
                    to: '/settings'
                }
            ],
            items2: [
                {
                    label: 'Home',
                    icon: 'pi pi-fw pi-home'
                },
                {
                    label: 'Calendar',
                    icon: 'pi pi-fw pi-calendar'
                },
                {
                    label: 'Edit',
                    icon: 'pi pi-fw pi-pencil'
                },
                {
                    label: 'Documentation',
                    icon: 'pi pi-fw pi-file'
                },
                {
                    label: 'Settings',
                    icon: 'pi pi-fw pi-cog'
                }
            ]
        }
    }
}
<\\/script>

<style scoped lang="scss">
::v-deep(.tabmenudemo-content) {
    padding: 2rem 1rem;
}
</style>`
                },
                'composition-api': {
                    tabName: 'Composition API Source',
                    content: `
<template>
    <div>
        <div class="card">
            <h5>Default</h5>
            <TabMenu :model="items" />
            <router-view/>
        </div>

        <div class="card">
            <h5>Programmatic</h5>
            <div class="py-2">
                <Button @click="active = 0" class="p-button-text" label="Activate 1st" />
                <Button @click="active = 1" class="p-button-text mr-2" label="Activate 2nd" />
                <Button @click="active = 2" class="p-button-text mr-2" label="Activate 3rd" />
            </div>

            <TabMenu :model="items2" v-model:activeIndex="active" />
        </div>
    </div>
</template>

<script>
import { ref } from 'vue';

export default {
    setup() {
        const active = ref(3);
        const items = ref([
            {
                label: 'Home',
                icon: 'pi pi-fw pi-home',
                to: '/'
            },
            {
                label: 'Calendar',
                icon: 'pi pi-fw pi-calendar',
                to: '/calendar'
            },
            {
                label: 'Edit',
                icon: 'pi pi-fw pi-pencil',
                to: '/edit'
            },
            {
                label: 'Documentation',
                icon: 'pi pi-fw pi-file',
                to: '/documentation'
            },
            {
                label: 'Settings',
                icon: 'pi pi-fw pi-cog',
                to: '/settings'
            }
        ]);
        const items2 = ref([
            {
                label: 'Home',
                icon: 'pi pi-fw pi-home'
            },
            {
                label: 'Calendar',
                icon: 'pi pi-fw pi-calendar'
            },
            {
                label: 'Edit',
                icon: 'pi pi-fw pi-pencil'
            },
            {
                label: 'Documentation',
                icon: 'pi pi-fw pi-file'
            },
            {
                label: 'Settings',
                icon: 'pi pi-fw pi-cog'
            }
        ]);

        return { active, items, items2 }
    }
}
<\\/script>

<style scoped lang="scss">
::v-deep(.tabmenudemo-content) {
    padding: 2rem 1rem;
}
</style>`
                },
                'browser-source': {
                    tabName: 'Browser Source',
                    imports: `<script src="https://unpkg.com/vue-router@4.0.0/dist/vue-router.global.js"><\\/script>
        <script src="https://unpkg.com/primevue@^3/tabmenu/tabmenu.min.js"><\\/script>`,
                    content: `<div id="app">
            <div class="card">
                <h5>Default</h5>
                <p-tabmenu :model="items"></p-tabmenu>
                <router-view></router-view>
            </div>

            <div class="card">
                <h5>Programmatic</h5>
                <div class="py-2">
                    <p-button @click="active = 0" class="p-button-text" label="Activate 1st"></p-button>
                    <p-button @click="active = 1" class="p-button-text mr-2" label="Activate 2nd"></p-button>
                    <p-button @click="active = 2" class="p-button-text mr-2" label="Activate 3rd"></p-button>
                </div>

                <p-tabmenu :model="items2" v-model:active-index="active"></p-tabmenu>
            </div>
        </div>

        <script type="module">
        const { createApp, ref } = Vue;

        const App = {
            setup() {
                const active = ref(3);
                const items = ref([
                    {
                        label: 'Home',
                        icon: 'pi pi-fw pi-home',
                        to: '/'
                    },
                    {
                        label: 'Calendar',
                        icon: 'pi pi-fw pi-calendar',
                        to: '/calendar'
                    },
                    {
                        label: 'Edit',
                        icon: 'pi pi-fw pi-pencil',
                        to: '/edit'
                    },
                    {
                        label: 'Documentation',
                        icon: 'pi pi-fw pi-file',
                        to: '/documentation'
                    },
                    {
                        label: 'Settings',
                        icon: 'pi pi-fw pi-cog',
                        to: '/settings'
                    }
                ]);
                const items2 = ref([
                    {
                        label: 'Home',
                        icon: 'pi pi-fw pi-home'
                    },
                    {
                        label: 'Calendar',
                        icon: 'pi pi-fw pi-calendar'
                    },
                    {
                        label: 'Edit',
                        icon: 'pi pi-fw pi-pencil'
                    },
                    {
                        label: 'Documentation',
                        icon: 'pi pi-fw pi-file'
                    },
                    {
                        label: 'Settings',
                        icon: 'pi pi-fw pi-cog'
                    }
                ]);

                return { active, items, items2 }
            },
            components: {
                "p-tabmenu": primevue.tabmenu,
                "p-button": primevue.button
            }
        };

        const Home = {
            template: \`<div class="tabmenudemo-content">
                <h5>Home Component Content</h5>
            </div>\`
        };

        const Calendar = {
            template: \`<div class="tabmenudemo-content">
                <h5>Calendar Component Content</h5>
            </div>\`
        };

        const Edit = {
            template: \`<div class="tabmenudemo-content">
                <h5>Edit Component Content</h5>
            </div>\`
        };

        const Documentation = {
            template: \`<div class="tabmenudemo-content">
                <h5>Documentation Component Content</h5>
            </div>\`
        };

        const Settings = {
            template: \`<div class="tabmenudemo-content">
                <h5>Settings Component Content</h5>
            </div>\`
        };

        const routes = [
            { path: "/", component: Home },
            { path: "/home", component: Home },
            { path: "/calendar", component: Calendar },
            { path: "/edit", component: Edit },
            { path: "/documentation", component: Documentation },
            { path: "/settings", component: Settings }
        ];

        const router = VueRouter.createRouter({
            history: VueRouter.createWebHashHistory(),
            routes
        });

        createApp(App)
            .use(router)
            .use(primevue.config.default)
            .mount("#app");

        <\\/script>

        <style>
        .tabmenudemo-content {
            padding: 2rem 1rem;
        }
        </style>`
                }
            },
            pages: [
                {
                    tabName: 'HomeDemo',
                    content: `
<template>
    <div class="tabmenudemo-content">
        <h5>Home Component Content</h5>
    </div>
</template>

<script>
export default {

}
<\\/script>
`
                },
                {
                    tabName: 'CalendarDemo',
                    content: `
<template>
    <div class="tabmenudemo-content">
        <h5>Calendar Component Content</h5>
    </div>
</template>

<script>
export default {

}
<\\/script>
`
                },
                {
                    tabName: 'EditDemo',
                    content: `
<template>
    <div class="tabmenudemo-content">
        <h5>Edit Component Content</h5>
    </div>
</template>

<script>
export default {

}
<\\/script>
`
                },
                {
                    tabName: 'DocumentationDemo',
                    content: `
<template>
    <div class="tabmenudemo-content">
        <h5>Documentation Component Content</h5>
    </div>
</template>

<script>
export default {

}
<\\/script>
`
                },
                {
                    tabName: 'SettingsDemo',
                    content: `
<template>
    <div class="tabmenudemo-content">
        <h5>Settings Component Content</h5>
    </div>
</template>

<script>
export default {

}
<\\/script>`
                }
            ]
        };
    }
};
</script>