Filtros - Yampi Developer Portal

Módulo Vuex que mantém a lista de filtros ativos e os query params iniciais de listagem. Trabalha em conjunto com o módulo queryParams para refletir o estado dos filtros na URL.

State

Propriedade	Tipo	Descrição
`activeFilters`	`Array`	Lista de filtros atualmente ativos.
`queryParams`	`Object`	Query params base de listagem: `filter_id`, `category_id`, `brand_id`, `promotion_id`.

Getters

Getter	Tipo	Descrição
`activeFilters`	`Array`	Lista de filtros ativos.
`queryParams`	`Object`	Query params base do módulo de filtros.

Actions

Action	Parâmetros	Descrição
`addActiveFilter`	`filter: Object`	Adiciona um filtro à lista de filtros ativos.
`removeActiveFilter`	`{ alias }`	Remove um filtro da lista pelo alias.
`bootQueryParams`	—	Inicializa os query params a partir da URL atual, incluindo contexto de categoria/coleção/promoção.

Estrutura de um filtro ativo

{
    id: 123,
    key: 'brand_id',        // tipo do filtro
    alias: 'brand_id-123',  // identificador único
    name: 'Nike',           // nome exibido
    query: { brand_id: 123 },
}

Uso

import { mapGetters, mapActions } from 'vuex';

export default {
    computed: {
        ...mapGetters('filters', ['activeFilters']),
    },
    methods: {
        ...mapActions('filters', ['addActiveFilter', 'removeActiveFilter']),
    },
};

⌘I