@y7k/component-filterable-list v1.0.9

Y7K Component: Filterable List

This component is a very abstract concept of making a list of anything filterable by whatever and display its items in whatever way you want. While this is a Vue component, you are free to create your list content in any markup you like. The component simply handles the task of initiating loading of more list items.

It is based on Vue 2, MaintainableCSS and the Y7K Style Plate. Detailed information in the Y7K Showroom.

Installation

Install npm package

npm install @y7k/component-filterable-list --save

Include in your project

import filterableList from '@y7k/component-filterable-list';

Variant 1: Register components globally:

import filterableList from '@y7k/component-filterable-list';
filterableList.registerGlobally();

Variant 2: Use components directly:

import { FilterableList } from '@y7k/component-filterable-list';

// Vue component example
export default {

    components: {
        FilterableList,
    },
}

Include styles

In your main.scss file

@import '@y7k/filterable-list/src/scss/filterableList';

// You need the styles for these dependencies aswell
@import '@y7k/component-dropdown/src/scss/dropdown';
@import '@y7k/component-checkbox/src/scss/checkbox';
@import '@y7k/component-text-input/src/scss/textInput';
@import '@y7k/component-button-bar/src/scss/buttonBar';
@import '@y7k/component-navigation-bar/src/scss/navigationBar';

// If you don't set "node_modules" as a webpack include path:
@import '../[path]/../node_modules/@y7k/component-filterable-list/src/scss/@import';
@import '../[path]/../node_modules/@y7k/component-dropdown/src/scss/dropdown';
@import '../[path]/../node_modules/@y7k/component-checkbox/src/scss/checkbox';
@import '../[path]/../node_modules/@y7k/component-text-input/src/scss/textInput';
@import '../[path]/../node_modules/@y7k/component-button-bar/src/scss/buttonBar';
@import '../[path]/../node_modules/@y7k/component-navigation-bar/src/scss/navigationBar';

Documentation

Please have a look at the usage documentation in the Y7K Showroom.