vertumnus
/
primevue-mirror
mirror of https://github.com/primefaces/primevue.git
1
0
Fork 0
Code Packages Releases Activity

Accordion doc added

pull/12/head
Merve Özçifçi 2019-03-28 17:23:26 +03:00
parent 1cc036b10e
commit 6725499fe3
2 changed files with 405 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/views/accordion/AccordionDemo.vue
View File

@ -104,12 +104,15 @@
A decade earlier, he gave custody of his two children to Kay, who has since remarried. A decade earlier, he gave custody of his two children to Kay, who has since remarried.
</AccordionTab> </AccordionTab>
</Accordion> </Accordion>
</div> </div>
<AccordionDoc/>
</div> </div>
</template> </template>
<script> <script>
import AccordionDoc from './AccordionDoc';
export default { export default {
data() { data() {
return { return {
@ -117,6 +120,9 @@ export default {
active2: false, active2: false,
active3: false active3: false
} }
},
components: {
'AccordionDoc': AccordionDoc
} }
} }
</script> </script>

398
src/views/accordion/AccordionDoc.vue Normal file
View File

@ -0,0 +1,398 @@
<template>
<div class="content-section documentation">
<TabView>
<TabPanel header="Documentation">
<h3>Import</h3>
<CodeHighlight lang="javascript">
import Accordion from 'primevue/accordion';
</CodeHighlight>
<h3>Getting Started</h3>
<p>Accordion element consists of one or more AccordionTab elements. Title of the tab is defined using header attribute.</p>
<CodeHighlight>
&lt;Accordion&gt;
&lt;AccordionTab header=&quot;Header I&quot;&gt;
Content
&lt;/AccordionTab&gt;
&lt;AccordionTab header=&quot;Header II&quot;&gt;
Content
&lt;/AccordionTab&gt;
&lt;AccordionTab header=&quot;Header III&quot;&gt;
Content
&lt;/AccordionTab&gt;
&lt;/Accordion&gt;
</CodeHighlight>
<h3>Active</h3>
<p>Visibility of the content is specified with the active property that supports one or two-way binding.</p>
<CodeHighlight>
&lt;Accordion&gt;
&lt;AccordionTab header=&quot;Header I&quot; :active=&quot;true&quot;&gt;
Content
&lt;/AccordionTab&gt;
&lt;AccordionTab header=&quot;Header II&quot;&gt;
Content
&lt;/AccordionTab&gt;
&lt;AccordionTab header=&quot;Header III&quot;&gt;
Content
&lt;/AccordionTab&gt;
&lt;/Accordion&gt;
</CodeHighlight>
<h3>Multiple</h3>
<p>By default only one tab at a time can be active, enabling multiple property changes this behavior to allow multiple
tabs be active at the same time.</p>
<CodeHighlight>
&lt;Accordion :multiple=&quot;true&quot; &gt;
&lt;AccordionTab header=&quot;Header I&quot;&gt;
Content
&lt;/AccordionTab&gt;
&lt;AccordionTab header=&quot;Header II&quot;&gt;
Content
&lt;/AccordionTab&gt;
&lt;AccordionTab header=&quot;Header III&quot;&gt;
Content
&lt;/AccordionTab&gt;
&lt;/Accordion&gt;
</CodeHighlight>
<h3>Disabled</h3>
<p>A tab can be disabled by setting the disabled property to true.</p>
<CodeHighlight>
&lt;Accordion&gt;
&lt;AccordionTab header=&quot;Header I&quot;&gt;
Content
&lt;/AccordionTab&gt;
&lt;AccordionTab header=&quot;Header II&quot;&gt;
Content
&lt;/AccordionTab&gt;
&lt;AccordionTab header=&quot;Header III&quot; :disabled=&quot;true&quot;&gt;
Content
&lt;/AccordionTab&gt;
&lt;/Accordion&gt;
</CodeHighlight>
<h3>Custom Content at Headers</h3>
<p>Custom content can be placed at an accordion header with header element.</p>
<CodeHighlight>
&lt;Accordion&gt;
&lt;AccordionTab&gt;
&lt;template slot=&quot;header&quot;&gt;
&lt;i class=&quot;pi pi-calendar&quot;&gt;&lt;/i&gt;
&lt;span&gt;Header I&lt;/span&gt;
&lt;/template&gt;
Content
&lt;/AccordionTab&gt;
&lt;AccordionTab&gt;
&lt;template slot=&quot;header&quot;&gt;
&lt;i class=&quot;pi pi-calendar&quot;&gt;&lt;/i&gt;
&lt;span&gt;Header II&lt;/span&gt;
&lt;/template&gt;
Content
&lt;/AccordionTab&gt;
&lt;AccordionTab&gt;
&lt;template slot=&quot;header&quot;&gt;
&lt;i class=&quot;pi pi-calendar&quot;&gt;&lt;/i&gt;
&lt;span&gt;Header III&lt;/span&gt;
&lt;/template&gt;
Content
&lt;/AccordionTab&gt;
&lt;/Accordion&gt;
</CodeHighlight>
<h3>Programmatic Control</h3>
<p>Tabs can be controlled programmatically using active property.</p>
<CodeHighlight>
&lt;div&gt;
&lt;Button :icon=&quot;active1 ? 'pi pi-minus' : 'pi pi-plus'&quot; label=&quot;Toggle 1st&quot; @click=&quot;active1 = !active1&quot; class=&quot;p-button-secondary&quot; /&gt;
&lt;Button :icon=&quot;active2 ? 'pi pi-minus' : 'pi pi-plus'&quot; label=&quot;Toggle 2nd&quot; @click=&quot;active2 = !active2&quot; class=&quot;p-button-secondary&quot; style=&quot;margin-left: .5em&quot; /&gt;
&lt;Button :icon=&quot;active3 ? 'pi pi-minus' : 'pi pi-plus'&quot; label=&quot;Toggle 3rd&quot; @click=&quot;active3 = !active3&quot; class=&quot;p-button-secondary&quot; style=&quot;margin-left: .5em&quot; /&gt;
&lt;/div&gt;
&lt;Accordion :multiple=&quot;true&quot;&gt;
&lt;AccordionTab header=&quot;Header I&quot; :active=&quot;active1&quot;&gt;
Content
&lt;/AccordionTab&gt;
&lt;AccordionTab header=&quot;Header II&quot; :active=&quot;active2&quot;&gt;
Content
&lt;/AccordionTab&gt;
&lt;AccordionTab header=&quot;Header III&quot; :active=&quot;active3&quot;&gt;
Content
&lt;/AccordionTab&gt;
&lt;/Accordion&gt;
</CodeHighlight>
<CodeHighlight lang="js">
export default {
data() {
return {
active1: true,
active2: false,
active3: false
}
}
}
</CodeHighlight>
<h3>Properties For AccordionTab</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>false</td>
<td>Whether the tab is disabled.</td>
</tr>
</tbody>
</table>
</div>
<h3>Properties</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>multiple</td>
<td>boolean</td>
<td>false</td>
<td>When enabled, multiple tabs can be activated at the same time.</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>tabOpen</td>
<td>event.originalEvent: browser event <br/>
event.tab: Opened tab
</td>
<td>Callback to invoke when a tab gets expanded.</td>
</tr>
<tr>
<td>tabClose</td>
<td>event.originalEvent: browser event <br/>
event.tab: Closed tab
</td>
<td>Callback to invoke when an active tab is collapsed by clicking on the header.</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-accordion</td>
<td>Container element.</td>
</tr>
<tr>
<td>p-accordion-header</td>
<td>Header of a tab.</td>
</tr>
<tr>
<td>p-accordion-content</td>
<td>Container 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/accordion" class="btn-viewsource" target="_blank" rel="noopener noreferrer">
<span>View on GitHub</span>
</a>
<CodeHighlight>
<template v-pre>
&lt;template&gt;
&lt;div&gt;
&lt;div class=&quot;content-section introduction&quot;&gt;
&lt;div class=&quot;feature-intro&quot;&gt;
&lt;h1&gt;AccordionPanel&lt;/h1&gt;
&lt;p&gt;AccordionPanel groups a collection of contents in tabs.&lt;/p&gt;
&lt;/div&gt;
&lt;/div&gt;
&lt;div class=&quot;content-section implementation&quot;&gt;
&lt;h3 class=&quot;first&quot;&gt;Default&lt;/h3&gt;
&lt;Accordion&gt;
&lt;AccordionTab header=&quot;Godfather I&quot;&gt;
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.
&lt;/AccordionTab&gt;
&lt;AccordionTab header=&quot;Godfather II&quot;&gt;
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.
&lt;/AccordionTab&gt;
&lt;AccordionTab header=&quot;Godfather III&quot;&gt;
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.
&lt;/AccordionTab&gt;
&lt;/Accordion&gt;
&lt;h3&gt;Multiple&lt;/h3&gt;
&lt;Accordion :multiple=&quot;true&quot;&gt;
&lt;AccordionTab header=&quot;Godfather I&quot;&gt;
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.
&lt;/AccordionTab&gt;
&lt;AccordionTab header=&quot;Godfather II&quot;&gt;
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.
&lt;/AccordionTab&gt;
&lt;AccordionTab header=&quot;Godfather III&quot;&gt;
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.
&lt;/AccordionTab&gt;
&lt;AccordionTab header=&quot;Godfather IV&quot; :disabled=&quot;true&quot;&gt;
&lt;/AccordionTab&gt;
&lt;/Accordion&gt;
&lt;h3&gt;Programmatic&lt;/h3&gt;
&lt;div style=&quot;padding: .5em 0&quot;&gt;
&lt;Button :icon=&quot;active1 ? 'pi pi-minus' : 'pi pi-plus'&quot; label=&quot;Toggle 1st&quot; @click=&quot;active1 = !active1&quot; class=&quot;p-button-secondary&quot; /&gt;
&lt;Button :icon=&quot;active2 ? 'pi pi-minus' : 'pi pi-plus'&quot; label=&quot;Toggle 2nd&quot; @click=&quot;active2 = !active2&quot; class=&quot;p-button-secondary&quot; style=&quot;margin-left: .5em&quot; /&gt;
&lt;Button :icon=&quot;active3 ? 'pi pi-minus' : 'pi pi-plus'&quot; label=&quot;Toggle 3rd&quot; @click=&quot;active3 = !active3&quot; class=&quot;p-button-secondary&quot; style=&quot;margin-left: .5em&quot; /&gt;
&lt;/div&gt;
&lt;Accordion :multiple=&quot;true&quot;&gt;
&lt;AccordionTab header=&quot;Godfather I&quot; :active=&quot;active1&quot;&gt;
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.
&lt;/AccordionTab&gt;
&lt;AccordionTab header=&quot;Godfather II&quot; :active=&quot;active2&quot;&gt;
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.
&lt;/AccordionTab&gt;
&lt;AccordionTab header=&quot;Godfather III&quot; :active=&quot;active3&quot;&gt;
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.
&lt;/AccordionTab&gt;
&lt;/Accordion&gt;
&lt;h3&gt;Custom Headers&lt;/h3&gt;
&lt;Accordion class=&quot;accordion-custom&quot;&gt;
&lt;AccordionTab&gt;
&lt;template slot=&quot;header&quot;&gt;
&lt;i class=&quot;pi pi-calendar&quot;&gt;&lt;/i&gt;
&lt;span&gt;Godfather I&lt;/span&gt;
&lt;/template&gt;
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.
&lt;/AccordionTab&gt;
&lt;AccordionTab&gt;
&lt;template slot=&quot;header&quot;&gt;
&lt;i class=&quot;pi pi-user&quot;&gt;&lt;/i&gt;
&lt;span&gt;Godfather II&lt;/span&gt;
&lt;/template&gt;
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.
&lt;/AccordionTab&gt;
&lt;AccordionTab&gt;
&lt;template slot=&quot;header&quot;&gt;
&lt;i class=&quot;pi pi-search&quot;&gt;&lt;/i&gt;
&lt;span&gt;Godfather III&lt;/span&gt;
&lt;i class=&quot;pi pi-cog&quot;&gt;&lt;/i&gt;
&lt;/template&gt;
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.
&lt;/AccordionTab&gt;
&lt;/Accordion&gt;
&lt;/div&gt;
&lt;/div&gt;
&lt;/template&gt;
</template>
</CodeHighlight>
<CodeHighlight lang="javascript">
export default {
data() {
return {
active1: true,
active2: false,
active3: false
}
}
}
</CodeHighlight>
<CodeHighlight lang="css">
.accordion-custom {
i, span {
vertical-align: middle;
}
span {
margin: 0 .5em;
}
}
</CodeHighlight>
</TabPanel>
</TabView>
</div>
</template>