artkravchenko
commented
7 years ago @voidxnull, @indeyets, @xekc,
Насколько я понимаю, подобный интерфейс будет существовать для всех видов тегов. Кроме того, в скором времени будет применяться поиск, а также фильтрация по подпискам со стороны групп пользователей (друзей, например).
Предлагаю создать контроллер вида /tags/all (по аналогии с /posts/all), который может выдавать или сплошной массив значений (тегов), или их группы, сформированные по какому-либо признаку (интерфейс слева на скриншоте). Таким образом, значением "верхнего уровня" является либо тэг, либо группа тэгов. Группа выглядит подобным образом:
type TagGroup<T> = {
count: number, // число всех тэгов, приналеджащих группе
entries: Array<T>, // массив тэгов с числом элементов N <= query.group_limit
offset: number,
key: string, // признак группировки
value: string // значение по ключу key, общее для тэгов в группе
// (в случае с query.group_by === 'first_letter' обозначает заголовок группы)
}Отсюда следующие query-параметры:
group_by- назначает группировку по первой букве названияgroup_by=first_letter, местоположению и т. д.; если используется, ответ в виде массива групп (объекты заданного вида с тэгами внутри), иначе в виде массива значений (тэгов);sort- сортировка значений верхнего уровня, т. е. групп, если используетсяgroup_by, или тегов. Может выглядеть какsort=-first_letterдля групп или, например,sort=-updated_atдля тэгов;group_sort- сортировка значений внутри группы; например,group_sort=-post_count; применимо, если используется параметрgroup_by;type- тип тегов в выдаче; например,type=hashtag;limit- максимальное количество значений верхнего уровня в одном ответе: если используетсяgroup_by, максимальное число групп в одном ответе, иначе максимальное количество тегов; по умолчанию 3-5 для групп или ... (сколько, @xekc ?) для тегов.group_limit- максимальное число значений внутри группы, если используетсяgroup_by; по умолчанию10;queryилиq- поисковый запрос по названию (?) тэга;offset- пропуск опр. числа первых значений верхнего уровня;
Позже появится фильтрация по пользователям:
followers- подписчики тэгов; например,meдля текущего пользователя,friendsдля любого из его друзей илиidконкретного пользователя; суммируется (может быть массивом);likers- аналогичноfollowers, только относится к лайкам.
Тогда запрос внутрь категории хэштэгов, собранной по первой букве названия, может быть выполнен следующим образом:
GET /api/v1/tags/all?q=A&sort=-q&type=hashtagЗапросим группированный список:
GET /api/v1/tags/all?group_by=first_letter&group_sort=-post_count&sort=-first_letter&type=hashtagsВ рамках store результат может выглядеть примерно так:
store = {
rivers: {
sidebar_tags: {
queries: {
'group_by=first_letter&group_sort=-post_count&sort=-first_letter&type=hashtags': [
{
count: 20,
entries: ['uuid_1', 'uuid_2'],
key: 'starts_with',
value: 'A'
}
],
// дополняемый массив, используемый на странице отдельной группы
'sort=-post_count&starts_with=A&type=hashtags': [
'uuid_1',
'uuid_2'
]
}
}
},
hashtags: {
'uuid_1': {},
'uuid_2': {}
}
}В целом из-за будущего внедрения поиска и фильтрации здесь, вероятно, имеет смысл провести рефакторинг существующего клиентского кода, обслуживающего поисковую функциональность, чтобы осуществлять code sharing. Во всяком случае в store для кэширования результатов.
voidxnull
Concept design
In this concept interface user is able to see an alphabetical list of all hashtags on the site. You can See alphabetical sub-headers and then alphabetical list of all tags with counters (used times).
Implementation
[x] We will do English only for now.
[ ] We need client-side implementation for this. @Oopscurity you'll need to work with the picture above, please mind the horizontal sizes (well, basically all sizes, but sidebar width is crucial) are done well.
[ ] (COULD Have) We'll likely need auto-load on scrolling here. @Oopscurity can you do it?
[ ] @voidxnull we'll need server side / data work to display all tags as pictured on those pictures. First implementation can have only tags output, or you can do both left and right sides of the picture together (then when you click on a tag you see all posts tagged with in, most recent first).
[ ] @indeyets ideally it would be great to work with your input on possible optimal implementation architecture here?
[ ] @voidxnull we'll need development and integration of the same list for School tags and Location tags. Just alphabetical output, code must be rather close to tag clouds pages code?
Integration
This sidebar with full tags list by type will be developed further with added filters (show only my own tags, show only tags from Europe etc.) and further selection features. The point of going to sidebar for the user is to explore content in various perspectives that he finds relevant to his situation.
We will call this sidebar from random pages. We'll want request operators to be implemented - so that the list of tags that opens in sidebar is pre-filtered by URL parameters, sorted not alphabetically but by last modified, by number of user engagements. That will follow in further tasks. Right now we need a solid client side + basically the same server side that tag clouds have, revised and re-thought through in new context (how would "Load more" work if there's 100k tags?).