TabView doc added
Merve Özçifçi
parent
9c4b91c667
commit
a44a532758
|
|
@ -4,7 +4,7 @@
|
|||
<TabPanel header="Documentation">
|
||||
<h3>Import</h3>
|
||||
<CodeHighlight lang="javascript">
|
||||
import Accordion from 'primevue/accordion';
|
||||
import {Accordion, AccordionTab} from 'primevue/accordion';
|
||||
</CodeHighlight>
|
||||
|
||||
<h3>Getting Started</h3>
|
||||
|
|
|
|||
|
|
@ -103,10 +103,14 @@
|
|||
</TabPanel>
|
||||
</TabView>
|
||||
</div>
|
||||
|
||||
<TabViewDoc/>
|
||||
</div>
|
||||
</template>
|
||||
|
||||
<script>
|
||||
import TabViewDoc from './TabViewDoc';
|
||||
|
||||
export default {
|
||||
data() {
|
||||
return {
|
||||
|
|
@ -120,6 +124,9 @@ export default {
|
|||
prev() {
|
||||
this.activeIndex = this.activeIndex === 0 ? 2 : this.activeIndex - 1;
|
||||
}
|
||||
},
|
||||
components: {
|
||||
'TabViewDoc': TabViewDoc
|
||||
}
|
||||
}
|
||||
</script>
|
||||
|
|
|
|||
|
|
@ -0,0 +1,345 @@
|
|||
<template>
|
||||
<div class="content-section documentation">
|
||||
<TabView>
|
||||
<TabPanel header="Documentation">
|
||||
<h3>Import</h3>
|
||||
<CodeHighlight lang="javascript">
|
||||
import {TabView, TabPanel} from 'primevue/tabview';
|
||||
</CodeHighlight>
|
||||
|
||||
<h3>Getting Started</h3>
|
||||
<p>Tabview element consists of one or more TabPanel elements. Header of the tab is defined using header attribute.</p>
|
||||
<CodeHighlight>
|
||||
<TabView>
|
||||
<TabPanel header="Header I">
|
||||
Content I
|
||||
</TabPanel>
|
||||
<TabPanel header="Header II">
|
||||
Content II
|
||||
</TabPanel>
|
||||
<TabPanel header="Header III">
|
||||
Content III
|
||||
</TabPanel>
|
||||
</TabView>
|
||||
</CodeHighlight>
|
||||
|
||||
<h3>Programmatic Control</h3>
|
||||
<p>Tabs can be controlled programmatically using active property that defines the active tab.</p>
|
||||
<CodeHighlight>
|
||||
<div>
|
||||
<Button icon="pi pi-chevron-left" @click="prev"/>
|
||||
<Button icon="pi pi-chevron-right" @click="next"/>
|
||||
</div>
|
||||
|
||||
<TabView>
|
||||
<TabPanel header="Header I" :active="activeIndex === 0">
|
||||
Content I
|
||||
</TabPanel>
|
||||
<TabPanel header="Header II" :active="activeIndex === 1">
|
||||
Content II
|
||||
</TabPanel>
|
||||
<TabPanel header="Header III" :active="activeIndex === 2">
|
||||
Content III
|
||||
</TabPanel>
|
||||
</TabView>
|
||||
</CodeHighlight>
|
||||
|
||||
<CodeHighlight lang="js">
|
||||
export default {
|
||||
data() {
|
||||
return {
|
||||
activeIndex: 0
|
||||
}
|
||||
},
|
||||
methods: {
|
||||
next() {
|
||||
this.activeIndex = this.activeIndex === 2 ? 0 : this.activeIndex + 1;
|
||||
},
|
||||
prev() {
|
||||
this.activeIndex = this.activeIndex === 0 ? 2 : this.activeIndex - 1;
|
||||
}
|
||||
}
|
||||
}
|
||||
</CodeHighlight>
|
||||
|
||||
<h3>Disabled</h3>
|
||||
<p>A tab can be disabled to prevent the content to be displayed by setting the disabled property on a panel.</p>
|
||||
<CodeHighlight>
|
||||
<TabView>
|
||||
<TabPanel header="Header I">
|
||||
Content I
|
||||
</TabPanel>
|
||||
<TabPanel header="Header II">
|
||||
Content II
|
||||
</TabPanel>
|
||||
<TabPanel header="Header III" :disabled="true">
|
||||
Content III
|
||||
</TabPanel>
|
||||
</TabView>
|
||||
</CodeHighlight>
|
||||
|
||||
<h3>Header Template</h3>
|
||||
<p>Header of a tab supports templating to place custom html content instead of strings as well.</p>
|
||||
<CodeHighlight>
|
||||
<TabView class="tabview-custom">
|
||||
<TabPanel>
|
||||
<template slot="header">
|
||||
<i class="pi pi-calendar"></i>
|
||||
<span>Header I</span>
|
||||
</template>
|
||||
Content I
|
||||
</TabPanel>
|
||||
<TabPanel>
|
||||
<template slot="header">
|
||||
<span>Header II</span>
|
||||
<i class="pi pi-user"></i>
|
||||
</template>
|
||||
Content II
|
||||
</TabPanel>
|
||||
</TabView>
|
||||
</CodeHighlight>
|
||||
|
||||
<h3>Properties For TabPanel</h3>
|
||||
<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>header</td>
|
||||
<td>string</td>
|
||||
<td>null</td>
|
||||
<td>Orientation of tab headers.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>active</td>
|
||||
<td>boolean</td>
|
||||
<td>null</td>
|
||||
<td>Visibility of the content.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>disabled</td>
|
||||
<td>boolean</td>
|
||||
<td>null</td>
|
||||
<td>Whether the tab is disabled.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<h3>Events</h3>
|
||||
<div class="doc-tablewrapper">
|
||||
<table class="doc-table">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Parameters</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>tabchange</td>
|
||||
<td>event.originalEvent: Browser event <br/>
|
||||
event.tab: Selected tab
|
||||
</td>
|
||||
<td>Callback to invoke when an active tab is changed.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<h3>Styling</h3>
|
||||
<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-tabview</td>
|
||||
<td>Container element.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>p-tabview-nav</td>
|
||||
<td>Container of headers.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>p-tabview-selected</td>
|
||||
<td>Selected tab header.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>p-tabview-panels</td>
|
||||
<td>Container panels.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>p-tabview-panel</td>
|
||||
<td>Content of a tab.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<h3>Dependencies</h3>
|
||||
<p>None.</p>
|
||||
</TabPanel>
|
||||
|
||||
<TabPanel header="Source">
|
||||
<a href="https://github.com/primefaces/primevue/tree/master/src/views/tabview" class="btn-viewsource" target="_blank" rel="noopener noreferrer">
|
||||
<span>View on GitHub</span>
|
||||
</a>
|
||||
<CodeHighlight>
|
||||
<template v-pre>
|
||||
<template>
|
||||
<div>
|
||||
<div class="content-section introduction">
|
||||
<div class="feature-intro">
|
||||
<h1>TabView</h1>
|
||||
<p>TabView is a container component to group content with tabs.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="content-section implementation">
|
||||
<h3 class="first">Default</h3>
|
||||
<TabView>
|
||||
<TabPanel header="Godfather I">
|
||||
The story begins as Don Vito Corleone, the head of a New York Mafia family, overseeshis daughter's wedding. His beloved son ichael has just come home from the war,
|
||||
but does not intend to become part of his father's business. Through Michael's life the nature of the family business becomes clear. The business of the family is
|
||||
just like the head of the family, kind and benevolent to those who give respect, but given to ruthless violence whenever anything stands against the good of the family.
|
||||
</TabPanel>
|
||||
<TabPanel header="Godfather II">
|
||||
Francis Ford Coppola's legendary continuation and sequel to his landmark 1972 film, TheGodfather parallels the young Vito Corleone's rise with his son Michael's spiritual fall,
|
||||
deepening The Godfather's depiction of the dark side of the American dream. In the early 1900s, the child Vito flees his Sicilian village for America after the local Mafia kills
|
||||
his family. Vito struggles to make a living, legally or illegally, for his wife and growing brood in Little Italy.
|
||||
</TabPanel>
|
||||
<TabPanel header="Godfather III">
|
||||
The Godfather Part III is set in 1979 and 1980. Michael has moved back to New York and taken great strides to remove the family from crime. He turns over his New York criminal
|
||||
interests to longtime enforcer Joey Zasa. He uses his wealth in an attempt to rehabilitate his reputation through numerous philanthropic acts, administered by a foundation named after his father.
|
||||
A decade earlier, he gave custody of his two children to Kay, who has since remarried.
|
||||
</TabPanel>
|
||||
</TabView>
|
||||
|
||||
<h3>Programmatic</h3>
|
||||
<div style="padding: .5em 0">
|
||||
<Button icon="pi pi-chevron-left" @click="prev" class="p-button-secondary" />
|
||||
<Button icon="pi pi-chevron-right" @click="next" style="margin-left: .5em" class="p-button-secondary"/>
|
||||
</div>
|
||||
|
||||
<TabView>
|
||||
<TabPanel header="Godfather I" :active="activeIndex === 0">
|
||||
The story begins as Don Vito Corleone, the head of a New York Mafia family, overseeshis daughter's wedding. His beloved son ichael has just come home from the war,
|
||||
but does not intend to become part of his father's business. Through Michael's life the nature of the family business becomes clear. The business of the family is
|
||||
just like the head of the family, kind and benevolent to those who give respect, but given to ruthless violence whenever anything stands against the good of the family.
|
||||
</TabPanel>
|
||||
<TabPanel header="Godfather II" :active="activeIndex === 1">
|
||||
Francis Ford Coppola's legendary continuation and sequel to his landmark 1972 film, TheGodfather parallels the young Vito Corleone's rise with his son Michael's spiritual fall,
|
||||
deepening The Godfather's depiction of the dark side of the American dream. In the early 1900s, the child Vito flees his Sicilian village for America after the local Mafia kills
|
||||
his family. Vito struggles to make a living, legally or illegally, for his wife and growing brood in Little Italy.
|
||||
</TabPanel>
|
||||
<TabPanel header="Godfather III" :active="activeIndex === 2">
|
||||
The Godfather Part III is set in 1979 and 1980. Michael has moved back to New York and taken great strides to remove the family from crime. He turns over his New York criminal
|
||||
interests to longtime enforcer Joey Zasa. He uses his wealth in an attempt to rehabilitate his reputation through numerous philanthropic acts, administered by a foundation named after his father.
|
||||
A decade earlier, he gave custody of his two children to Kay, who has since remarried.
|
||||
</TabPanel>
|
||||
</TabView>
|
||||
|
||||
<h3>Disabled</h3>
|
||||
<TabView>
|
||||
<TabPanel header="Godfather I">
|
||||
The story begins as Don Vito Corleone, the head of a New York Mafia family, overseeshis daughter's wedding. His beloved son ichael has just come home from the war,
|
||||
but does not intend to become part of his father's business. Through Michael's life the nature of the family business becomes clear. The business of the family is
|
||||
just like the head of the family, kind and benevolent to those who give respect, but given to ruthless violence whenever anything stands against the good of the family.
|
||||
</TabPanel>
|
||||
<TabPanel header="Godfather II">
|
||||
Francis Ford Coppola's legendary continuation and sequel to his landmark 1972 film, TheGodfather parallels the young Vito Corleone's rise with his son Michael's spiritual fall,
|
||||
deepening The Godfather's depiction of the dark side of the American dream. In the early 1900s, the child Vito flees his Sicilian village for America after the local Mafia kills
|
||||
his family. Vito struggles to make a living, legally or illegally, for his wife and growing brood in Little Italy.
|
||||
</TabPanel>
|
||||
<TabPanel header="Godfather III">
|
||||
The Godfather Part III is set in 1979 and 1980. Michael has moved back to New York and taken great strides to remove the family from crime. He turns over his New York criminal
|
||||
interests to longtime enforcer Joey Zasa. He uses his wealth in an attempt to rehabilitate his reputation through numerous philanthropic acts, administered by a foundation named after his father.
|
||||
A decade earlier, he gave custody of his two children to Kay, who has since remarried.
|
||||
</TabPanel>
|
||||
<TabPanel header="Godfather IV" :disabled="true"></TabPanel>
|
||||
</TabView>
|
||||
|
||||
<h3>Custom Headers</h3>
|
||||
<TabView class="tabview-custom">
|
||||
<TabPanel>
|
||||
<template slot="header">
|
||||
<i class="pi pi-calendar"></i>
|
||||
<span>Godfather I</span>
|
||||
</template>
|
||||
The story begins as Don Vito Corleone, the head of a New York Mafia family, overseeshis daughter's wedding. His beloved son ichael has just come home from the war,
|
||||
but does not intend to become part of his father's business. Through Michael's life the nature of the family business becomes clear. The business of the family is
|
||||
just like the head of the family, kind and benevolent to those who give respect, but given to ruthless violence whenever anything stands against the good of the family.
|
||||
</TabPanel>
|
||||
<TabPanel>
|
||||
<template slot="header">
|
||||
<span>Godfather II</span>
|
||||
<i class="pi pi-user"></i>
|
||||
</template>
|
||||
Francis Ford Coppola's legendary continuation and sequel to his landmark 1972 film, TheGodfather parallels the young Vito Corleone's rise with his son Michael's spiritual fall,
|
||||
deepening The Godfather's depiction of the dark side of the American dream. In the early 1900s, the child Vito flees his Sicilian village for America after the local Mafia kills
|
||||
his family. Vito struggles to make a living, legally or illegally, for his wife and growing brood in Little Italy.
|
||||
</TabPanel>
|
||||
<TabPanel>
|
||||
<template slot="header">
|
||||
<i class="pi pi-search"></i>
|
||||
<span>Godfather III</span>
|
||||
<i class="pi pi-cog"></i>
|
||||
</template>
|
||||
The Godfather Part III is set in 1979 and 1980. Michael has moved back to New York and taken great strides to remove the family from crime. He turns over his New York criminal
|
||||
interests to longtime enforcer Joey Zasa. He uses his wealth in an attempt to rehabilitate his reputation through numerous philanthropic acts, administered by a foundation named after his father.
|
||||
A decade earlier, he gave custody of his two children to Kay, who has since remarried.
|
||||
</TabPanel>
|
||||
</TabView>
|
||||
</div>
|
||||
</div>
|
||||
</template>
|
||||
</template>
|
||||
</CodeHighlight>
|
||||
|
||||
<CodeHighlight lang="javascript">
|
||||
export default {
|
||||
data() {
|
||||
return {
|
||||
activeIndex: 0
|
||||
}
|
||||
},
|
||||
methods: {
|
||||
next() {
|
||||
this.activeIndex = this.activeIndex === 2 ? 0 : this.activeIndex + 1;
|
||||
},
|
||||
prev() {
|
||||
this.activeIndex = this.activeIndex === 0 ? 2 : this.activeIndex - 1;
|
||||
}
|
||||
}
|
||||
}
|
||||
</CodeHighlight>
|
||||
|
||||
<CodeHighlight lang="css">
|
||||
.tabview-custom {
|
||||
i, span {
|
||||
vertical-align: middle;
|
||||
}
|
||||
|
||||
span {
|
||||
margin: 0 .5em;
|
||||
}
|
||||
}
|
||||
</CodeHighlight>
|
||||
</TabPanel>
|
||||
</TabView>
|
||||
</div>
|
||||
</template>
|
||||
Loading…
Reference in New Issue