npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@n3/react-filters-kit

v0.11.4

Published

Fields for @n3/react-filters styled with @n3/kit

Downloads

398

Readme

@n3/react-filters-kit

Фильтры для @n3/react-filters, стилизованные с помощью @n3/kit

Использование

С компонентом Filterlist

import { Filterlist } from '@n3/react-filters/es/filterlist';
import { createFilters } from '@n3/react-filters-kit';

const filters = createFilters(params);

...

<Filterlist
  {...otherFilterlistProps}
  filters={{
    ...filters,
    ...otherFilters,
  }}
/>

Спиок опций params:

  • get - необязательное, асинхронная фунция загрузки опций. Принимает аргументы:

    1. url - строка;

    2. params - объект query-параметров.

С компонентом Filters

import { Filters } from '@n3/react-filters';
import { createFilters } from '@n3/react-filters-kit';

const filters = createFilters();

// ...

<Filters
  {...otherFiltersProps}
  filters={{
    ...filters,
    ...otherFilters,
  }}
/>

Реализованные фильтры

Общие параметры

  • initial - значение фильтра по умолчанию по умолчанию;

string

Инпут, использует Input для рендера поля, не имеет дополнительных атрибутов. Пример схемы:

{
  label: 'Поиск',
  type: 'string',
  name: 'search',
}

choice

Одиночный селект с заданным списком опций, использует Select для рендера поля. Дополнительные атрибуты:

  • choices - массив опций селекта формата { value, display_name }, где value - значение опции, отправляемое на сервер, display_name - лейбл опции;

  • valueKey - необязательное, ключ, по которому хранятся значения в опциях;

  • labelKey - необязательное, ключ, по которому хранятся заголовки в опциях.

Пример схемы:

{
  label: 'Цвет',
  type: 'choice',
  name: 'color',

  choices: [{
    value: 'red',
    display_name: 'Красный',
  }, {
    value: 'green',
    display_name: 'Зелёный',
  }, {
    value: 'blur',
    display_name: 'Синий',
  }],
}

multiple_choice

Мультиселект. Аналогичен choice, но отправляет массивы значений.

ajax_choice

Одиночный асинхронный селект. Дополнительные атрибуты:

  • choices_url - обязательное, url для загрузки опций. Опции могут приходить массивом или в формате drf ({ results, next });

  • mapResponse - необязательное, функция маппинга ответа сервера в формат react-select-async-paginate;

  • queryParams - необязательное, объект дополнительных query-параметров запроса;

  • searchParamName - необязательное, ключ, по которому передаётся строка поиска в query-параметры;

  • pageParamName - необязательное, ключ, по которому передаётся текущая страница query-параметры;

  • offsetParamName - необязательное, ключ, по которому передаётся индекс первой опции query-параметры;

  • valueKey - необязательное, ключ, по которому хранятся значения в опциях;

  • labelKey - необязательное, ключ, по которому хранятся заголовки в опциях;

  • parseValue - необязательное, функция загрузки опции по id. По умолчанию делается запрос на <choices_url><id>/ с параметрами queryParams. Принимает аргументы;

    1. get - из параметров createFilters;

    2. value - id опции;

    3. choicesUrl

    4. queryParams

    5. mapResponseSimple

  • mapResponseSimple - необязательное, функция маппинга загруженного значения при парсинге в опцию;

Пример схемы:

{
  label: 'Цвет',
  type: 'ajax_choice',
  name: 'color',

  choices_url: '/api/colors/',
}

ajax_multiple_choice

Асинхронный мультиселект. Аналогичен ajax_choice, но отправляет массивы значений.

date

Дейтпикер, использует Datepicker для рендера поля, не имеет дополнительных атрибутов. Пример схемы:

{
  label: 'Дата с',
  type: 'date',
  name: 'date_from',
}

datetime

Дейтпикер с возможностью выбора времени, использует Datepicker для рендера поля, не имеет дополнительных атрибутов. Пример схемы:

{
  label: 'Дата с',
  type: 'datetime',
  name: 'date_from',
}

boolean

Чекбокс, использует Checkbox для рендера поля, не имеет дополнительных атрибутов. Пример схемы:

{
  label: 'В наличии',
  type: 'boolean',
  name: 'available',
}