primevue-mirror/pages/picklist/PickListDoc.vue

<template>
    <ClientOnly>
<AppDoc name="PickListDemo" :sources="sources" :service="['ProductService']" :data="['products-small']" github="picklist/PickListDemo.vue">
        <h5>Import via Module</h5>
        <pre v-code.script><code>
import PickList from 'primevue/picklist';

</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/picklist/picklist.min.js"&gt;&lt;/script&gt;

</code></pre>

        <h5>Getting Started</h5>
        <p>PickList requires a multidimensional array as its value bound with the v-model directive and a template for its content that gets the <i>item</i> instance and the <i>index</i> via slotProps.</p>
        <pre v-code><code><template v-pre>
&lt;PickList v-model="cars" dataKey="vin"&gt;
    &lt;template #item="slotProps"&gt;
        &lt;div class="p-caritem"&gt;
            &lt;img :src="'/demo/images/car/' + slotProps.item.brand + '.png'"&gt;
            &lt;div&gt;
                &lt;span class="p-caritem-vin"&gt;{{slotProps.item.vin}}&lt;/span&gt;
                &lt;span&gt;{{slotProps.item.year}} - {{slotProps.item.color}}&lt;/span&gt;
            &lt;/div&gt;
        &lt;/div&gt;
    &lt;/template&gt;
&lt;/PickList&gt;
</template>
</code></pre>

        <h5>Templates</h5>
        <p>
            In addition to the mandatory "item" template, picklist provides "sourceheader" and "targetheader" slots to define content at header sections. Similarly custom content can be placed before and after the button controls for each section can
            be templates. View the slots section for more information.
        </p>
        <pre v-code><code><template v-pre>
&lt;PickList v-model="cars" dataKey="vin"&gt;
    &lt;template #sourceheader&gt;
        Available
    &lt;/template&gt;
    &lt;template #targetheader&gt;
        Selected
    &lt;/template&gt;
    &lt;template #item="slotProps"&gt;
        &lt;div class="p-caritem"&gt;
            &lt;img :src="'/demo/images/car/' + slotProps.item.brand + '.png'"&gt;
            &lt;div&gt;
                &lt;span class="p-caritem-vin"&gt;{{slotProps.item.vin}}&lt;/span&gt;
                &lt;span&gt;{{slotProps.item.year}} - {{slotProps.item.color}}&lt;/span&gt;
            &lt;/div&gt;
        &lt;/div&gt;
    &lt;/template&gt;
&lt;/PickList&gt;
</template>
</code></pre>

        <h5>Selection</h5>
        <p>
            In case you need to access the selected items in the list, define a binding to the <i>selection</i> property with the v-model directive so that it gets updated when the user makes a selection. Since it is two-way binding enabled, your
            changes to the selection will be reflected as well. Note that this is optional and only necessary when you need to access the selection.
        </p>

        <pre v-code><code><template v-pre>
&lt;PickList v-model="cars" dataKey="vin" v-model:selection="selection"&gt;
    &lt;template #item="slotProps"&gt;
        &lt;div class="p-caritem"&gt;
            &lt;img :src="'/demo/images/car/' + slotProps.item.brand + '.png'"&gt;
            &lt;div&gt;
                &lt;span class="p-caritem-vin"&gt;{{slotProps.item.vin}}&lt;/span&gt;
                &lt;span&gt;{{slotProps.item.year}} - {{slotProps.item.color}}&lt;/span&gt;
            &lt;/div&gt;
        &lt;/div&gt;
    &lt;/template&gt;
&lt;/PickList&gt;
</template>
</code></pre>

        <h5>DataKey</h5>
        <p>It is recommended to provide the name of the field that uniquely identifies the a record in the data via the <i>dataKey</i> property for better performance.</p>

        <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>modelValue</td>
                        <td>array</td>
                        <td>null</td>
                        <td>Value of the component as a multidimensional array.</td>
                    </tr>
                    <tr>
                        <td>selection</td>
                        <td>array</td>
                        <td>null</td>
                        <td>Selected items in the list as a multidimensional array.</td>
                    </tr>
                    <tr>
                        <td>metaKeySelection</td>
                        <td>boolean</td>
                        <td>true</td>
                        <td>
                            Defines whether metaKey is requred or not for the selection. <br />
                            When true metaKey needs to be pressed to select or unselect an item and <br />
                            when set to false selection of each item can be toggled individually. On touch enabled devices, metaKeySelection is turned off automatically.
                        </td>
                    </tr>
                    <tr>
                        <td>dataKey</td>
                        <td>string</td>
                        <td>null</td>
                        <td>Name of the field that uniquely identifies the a record in the data.</td>
                    </tr>
                    <tr>
                        <td>listStyle</td>
                        <td>object</td>
                        <td>null</td>
                        <td>Inline style of the the list element.</td>
                    </tr>
                    <tr>
                        <td>responsive</td>
                        <td>boolean</td>
                        <td>true</td>
                        <td>Whether the list optimizes layout based on screen size.</td>
                    </tr>
                    <tr>
                        <td>breakpoint</td>
                        <td>string</td>
                        <td>960px</td>
                        <td>The breakpoint to define the maximum width boundary when responsiveness is enabled.</td>
                    </tr>
                    <tr>
                        <td>stripedRows</td>
                        <td>boolean</td>
                        <td>false</td>
                        <td>Whether to displays rows with alternating colors.</td>
                    </tr>
                    <tr>
                        <td>showSourceControls</td>
                        <td>boolean</td>
                        <td>true</td>
                        <td>Whether to show buttons of source list.</td>
                    </tr>
                    <tr>
                        <td>showTargetControls</td>
                        <td>boolean</td>
                        <td>true</td>
                        <td>Whether to show buttons of target list.</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>reorder</td>
                        <td>
                            event.originalEvent: browser event <br />
                            event.value: Ordered list <br />
                            event.direction: Direction of the change; "up", "down", "bottom", "top" <br />
                            event.listIndex: Index of the list that is ordered, 0 represents the source and 1 represents the target list.
                        </td>
                        <td>Callback to invoke when the list is reordered.</td>
                    </tr>
                    <tr>
                        <td>move-to-target</td>
                        <td>
                            event.originalEvent: browser event <br />
                            event.items: Moved items
                        </td>
                        <td>Callback to invoke when one or more items are moved to the target list.</td>
                    </tr>
                    <tr>
                        <td>move-all-to-target</td>
                        <td>
                            event.originalEvent: browser event <br />
                            event.items: Moved items
                        </td>
                        <td>Callback to invoke when all items are moved to the target list.</td>
                    </tr>
                    <tr>
                        <td>move-to-source</td>
                        <td>
                            event.originalEvent: browser event <br />
                            event.items: Moved items
                        </td>
                        <td>Callback to invoke when one or more items are moved to the source list.</td>
                    </tr>
                    <tr>
                        <td>move-all-to-source</td>
                        <td>
                            event.originalEvent: browser event <br />
                            event.items: Moved items
                        </td>
                        <td>Callback to invoke when all items are moved to the source list.</td>
                    </tr>
                    <tr>
                        <td>selection-change</td>
                        <td>
                            event.originalEvent: browser event <br />
                            event.value: Selected item
                        </td>
                        <td>Callback to invoke when one or more items are moved to the other list.</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>header</td>
                        <td>-</td>
                    </tr>
                    <tr>
                        <td>item</td>
                        <td>
                            item: Item of the component<br />
                            index: Index of the item
                        </td>
                    </tr>
                    <tr>
                        <td>sourceheader</td>
                        <td>-</td>
                    </tr>
                    <tr>
                        <td>targetheader</td>
                        <td>-</td>
                    </tr>
                    <tr>
                        <td>sourcecontrolsstart</td>
                        <td>-</td>
                    </tr>
                    <tr>
                        <td>sourcecontrolsend</td>
                        <td>-</td>
                    </tr>
                    <tr>
                        <td>movecontrolsstart</td>
                        <td>-</td>
                    </tr>
                    <tr>
                        <td>movecontrolsend</td>
                        <td>-</td>
                    </tr>
                    <tr>
                        <td>targetcontrolsstart</td>
                        <td>-</td>
                    </tr>
                    <tr>
                        <td>targetcontrolsend</td>
                        <td>-</td>
                    </tr>
                </tbody>
            </table>
        </div>

        <h5>Styling</h5>
        <p>Following is the list of structural style classes, for theming classes visit <nuxt-link to="/theming">theming</nuxt-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-picklist</td>
                        <td>Container element.</td>
                    </tr>
                    <tr>
                        <td>p-picklist-source-controls</td>
                        <td>Container of source list buttons.</td>
                    </tr>
                    <tr>
                        <td>p-picklist-target-controls</td>
                        <td>Container of target list buttons.</td>
                    </tr>
                    <tr>
                        <td>p-picklist-buttons</td>
                        <td>Container of buttons.</td>
                    </tr>
                    <tr>
                        <td>p-picklist-listwrapper</td>
                        <td>Parent of a list element.</td>
                    </tr>
                    <tr>
                        <td>p-picklist-list</td>
                        <td>List element.</td>
                    </tr>
                    <tr>
                        <td>p-picklist-item</td>
                        <td>An item in the list.</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>
        <PickList v-model="products" listStyle="height:342px" dataKey="id">
            <template #sourceheader>
                Available
            </template>
            <template #targetheader>
                Selected
            </template>
            <template #item="slotProps">
                <div class="product-item">
                    <div class="image-container">
                        <img src="https://www.primefaces.org/wp-content/uploads/2020/05/placeholder.png" />
                    </div>
                    <div class="product-list-detail">
                        <h6 class="mb-2">{{slotProps.item.name}}</h6>
                        <i class="pi pi-tag product-category-icon"></i>
                        <span class="product-category">{{slotProps.item.category}}</span>
                    </div>
                    <div class="product-list-action">
                        <h6 class="mb-2">\${{slotProps.item.price}}</h6>
                        <span :class="'product-badge status-'+slotProps.item.inventoryStatus.toLowerCase()">{{slotProps.item.inventoryStatus}}</span>
                    </div>
                </div>
            </template>
        </PickList>
    </div>
</template>

<script>
import ProductService from './service/ProductService';

export default {
    data() {
        return {
            products: null
        }
    },
    productService: null,
    created() {
        this.productService = new ProductService();
    },
    mounted() {
        this.productService.getProductsSmall().then(data => this.products = [data, []]);
    }
}
<\\/script>

<style lang="scss" scoped>
.product-item {
	display: flex;
	align-items: center;
	padding: .5rem;
	width: 100%;

	img {
		width: 75px;
        box-shadow: 0 3px 6px rgba(0, 0, 0, 0.16), 0 3px 6px rgba(0, 0, 0, 0.23);
        margin-right: 1rem;
	}

	.product-list-detail {
		flex: 1 1 0;
	}

	.product-list-action {
		display: flex;
        flex-direction: column;
        align-items: flex-end;
    }

    .product-category-icon {
        vertical-align: middle;
        margin-right: .5rem;
        font-size: .875rem;
    }

    .product-category {
        vertical-align: middle;
        line-height: 1;
        font-size: .875rem;
    }
}

@media screen and (max-width: 576px) {
    .product-item {
        flex-wrap: wrap;

        .image-container {
            width: 100%;
            text-align: center;
        }

        img {
            margin: 0 0 1rem 0;
            width: 100px;
        }
    }
}
</style>`
                },
                'composition-api': {
                    tabName: 'Composition API Source',
                    content: `
<template>
    <div>
        <PickList v-model="products" listStyle="height:342px" dataKey="id">
            <template #sourceheader>
                Available
            </template>
            <template #targetheader>
                Selected
            </template>
            <template #item="slotProps">
                <div class="product-item">
                    <div class="image-container">
                        <img src="https://www.primefaces.org/wp-content/uploads/2020/05/placeholder.png" />
                    </div>
                    <div class="product-list-detail">
                        <h6 class="mb-2">{{slotProps.item.name}}</h6>
                        <i class="pi pi-tag product-category-icon"></i>
                        <span class="product-category">{{slotProps.item.category}}</span>
                    </div>
                    <div class="product-list-action">
                        <h6 class="mb-2">\${{slotProps.item.price}}</h6>
                        <span :class="'product-badge status-'+slotProps.item.inventoryStatus.toLowerCase()">{{slotProps.item.inventoryStatus}}</span>
                    </div>
                </div>
            </template>
        </PickList>
    </div>
</template>

<script>
import { ref, onMounted } from 'vue';
import ProductService from './service/ProductService';

export default {
    setup() {
        onMounted(() => {
            productService.value.getProductsSmall().then(data => products.value = [data, []]);
        })

        const products = ref(null);
        const productService = ref(new ProductService());

        return { products, productService }
    }
}
<\\/script>

<style lang="scss" scoped>
.product-item {
	display: flex;
	align-items: center;
	padding: .5rem;
	width: 100%;

	img {
		width: 75px;
        box-shadow: 0 3px 6px rgba(0, 0, 0, 0.16), 0 3px 6px rgba(0, 0, 0, 0.23);
        margin-right: 1rem;
	}

	.product-list-detail {
		flex: 1 1 0;
	}

	.product-list-action {
		display: flex;
        flex-direction: column;
        align-items: flex-end;
    }

    .product-category-icon {
        vertical-align: middle;
        margin-right: .5rem;
        font-size: .875rem;
    }

    .product-category {
        vertical-align: middle;
        line-height: 1;
        font-size: .875rem;
    }
}

@media screen and (max-width: 576px) {
    .product-item {
        flex-wrap: wrap;

        .image-container {
            width: 100%;
            text-align: center;
        }

        img {
            margin: 0 0 1rem 0;
            width: 100px;
        }
    }
}
</style>`
                },
                'browser-source': {
                    tabName: 'Browser Source',
                    imports: `<script src="https://unpkg.com/primevue@^3/picklist/picklist.min.js"><\\/script>
        <script src="./ProductService.js"><\\/script>`,
                    content: `<div id="app">
            <p-picklist v-model="products" list-style="height:342px" data-key="id">
                <template #sourceheader>
                    Available
                </template>
                <template #targetheader>
                    Selected
                </template>
                <template #item="slotProps">
                    <div class="product-item">
                        <div class="image-container">
                            <img src="https://www.primefaces.org/wp-content/uploads/2020/05/placeholder.png" />
                        </div>
                        <div class="product-list-detail">
                            <h6 class="mb-2">{{slotProps.item.name}}</h6>
                            <i class="pi pi-tag product-category-icon"></i>
                            <span class="product-category">{{slotProps.item.category}}</span>
                        </div>
                        <div class="product-list-action">
                            <h6 class="mb-2">\${{slotProps.item.price}}</h6>
                            <span :class="'product-badge status-'+slotProps.item.inventoryStatus.toLowerCase()">{{slotProps.item.inventoryStatus}}</span>
                        </div>
                    </div>
                </template>
            </p-picklist>
        </div>

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

        const App = {
            setup() {
                onMounted(() => {
                    productService.value.getProductsSmall().then(data => products.value = [data, []]);
                })

                const products = ref(null);
                const productService = ref(new ProductService());

                return { products, productService }
            },
            components: {
                "p-picklist": primevue.picklist
            }
        };

        createApp(App).use(primevue.config.default).mount("#app")
        <\\/script>

<style>
.product-item {
	display: flex;
	align-items: center;
	padding: .5rem;
	width: 100%;
}

.product-item img {
	width: 75px;
    box-shadow: 0 3px 6px rgba(0, 0, 0, 0.16), 0 3px 6px rgba(0, 0, 0, 0.23);
    margin-right: 1rem;
}

.product-item .product-list-detail {
	flex: 1 1 0;
}

.product-item .product-list-action {
	display: flex;
    flex-direction: column;
    align-items: flex-end;
}

.product-item .product-category-icon {
    vertical-align: middle;
    margin-right: .5rem;
    font-size: .875rem;
}

.product-item .product-category {
    vertical-align: middle;
    line-height: 1;
    font-size: .875rem;
}

@media screen and (max-width: 576px) {
    .product-item {
        flex-wrap: wrap;
    }

    .product-item .image-container {
        width: 100%;
        text-align: center;
    }

    .product-item img {
        margin: 0 0 1rem 0;
        width: 100px;
    }
}
</style>`
                }
            }
        };
    }
};
</script>