Doc update

pull/12/head
cagataycivici 2019-05-27 13:01:42 +03:00
parent 4c32f256f6
commit ccd0d20908
2 changed files with 15 additions and 0 deletions

View File

@ -7,6 +7,9 @@
import DataView from 'primevue/dataview'; import DataView from 'primevue/dataview';
</CodeHighlight> </CodeHighlight>
<h3>PrimeFlex</h3>
<p>DataView utilizes PrimeFlex library so it needs to be installed before getting started. Refer to <router-link to="/theming">FlexGrid</router-link> documentation for details.</p>
<h3>Getting Started</h3> <h3>Getting Started</h3>
<p>DataView requires a collection of items as its value and one or more templates depending on the layout mode e.g. list and grid. Throughout the samples, a car interface having vin, brand, year and color properties are used to define an object to be displayed by the dataview. Cars are loaded by a CarService that connects to a server to fetch the cars.</p> <p>DataView requires a collection of items as its value and one or more templates depending on the layout mode e.g. list and grid. Throughout the samples, a car interface having vin, brand, year and color properties are used to define an object to be displayed by the dataview. Cars are loaded by a CarService that connects to a server to fetch the cars.</p>
<CodeHighlight lang="js"> <CodeHighlight lang="js">

View File

@ -2,6 +2,18 @@
<div class="content-section documentation flexgrid-demo"> <div class="content-section documentation flexgrid-demo">
<TabView> <TabView>
<TabPanel header="Documentation"> <TabPanel header="Documentation">
<h3>Install</h3>
<p>PrimeFlex is available at npm, if you have an existing application run the following command to download it to your project.</p>
<CodeHighlight lang="js">
npm install primeflex --save
</CodeHighlight>
<p>Then add the primeflex.css to your application</p>
<CodeHighlight lang="js">
import 'primeflex/primeflex.css';
</CodeHighlight>
<h3>Getting Started</h3> <h3>Getting Started</h3>
<p>FlexGrid is a CSS utility based on flexbox. For more information about Flex, visit <a href="https://css-tricks.com/snippets/css/a-guide-to-flexbox/">A Complete Guide to Flexbox</a>. A basic grid is defined by giving <p>FlexGrid is a CSS utility based on flexbox. For more information about Flex, visit <a href="https://css-tricks.com/snippets/css/a-guide-to-flexbox/">A Complete Guide to Flexbox</a>. A basic grid is defined by giving
a container <i>p-grid</i> class and children the <i>p-col</i> class. Children of the grid will have the same width and scale according to the width of the parent.</p> a container <i>p-grid</i> class and children the <i>p-col</i> class. Children of the grid will have the same width and scale according to the width of the parent.</p>