Badge (Vue)
В рамках YDF, значок (badge) — информационный неинтерактивный компонент, отображающий внутри прямоугольника со скруглёнными углами либо без таковых слово или другой набор символов наподобие даты и/или времени. Возможно добавить иконку, однако она не является заменой надписи, а дополняет её.
В UI/UX-фреймворках схожие компоненты могут иметь другие названия: Chip, Pill, Tag. Официальных определений у этих компонентов, а также официально установленных чётких различий нет: иногда в зависимости от фреймворка один и тот же компонент называется по-разному, а некоторые фреймворки дают свои определения, право чего оставляет за собой и YDF, не позиционирующий себя как фреймворк.
В YDF значком называется («badge») именно неинтерактивный компонент, который лишь отображает информацию. Его следует отличать от внешне похожих компонентов, с которыми можно взаимодействовать: использовать в качестве кнопки или ссылки, скрывать по клику на соответствующую внутреннюю кнопку и так далее. Также, YDF-значок поддерживает две надписи: ключ и значение, что очень важно когда, например, надо указать дату, но по одной иконке календаря может быть непонятно, дата чего именно указана.
Сводка
- Класс компонента
Badge- Live template-ы Vue-компонента (официальный плагин для семейства сред разработки IntelliJ IDEA)
- Наподобие автодополнения
- Pug-синтаксис
Badge--YDF-Vue-Pug- HTML-синтаксис
Badge--YDF-Vue-HTML
- Сокращённый
- Pug-синтаксис
bdg-ydf-vue-pug- HTML-синтаксис
bdg-ydf-vue-html
- Индикатор загрузки
- Pug-синтаксис
Badge-LoadingPlaceholder--YDF-Vue-Pug- HTML-синтаксис
Badge-LoadingPlaceholder--YDF-Vue-HTML
- Stylus-примесь для генерации стилей
generateBadgeYDF_GUI_ComponentStyles- Готовые темы
Badge.Themes.regular- Базовая (по умолчанию)
- Готовые геометрические вариации
Badge.GeometricVariations.regular- Базовая (по умолчанию)
Badge.GeometricVariations.small- Маленькая
- Геометрические модификаторы
Badge.GeometricModifiers.pillShape- Максимальное скругление углов
Badge.GeometricModifiers.singleLine- Всегда одна строка с усечением текста при нехватке ширины
- Готовые декоративные вариации
Badge.DecorativeVariations.veryCatchyBright- Очень броская яркая (красная по умолчанию)
Badge.DecorativeVariations.catchyBright- Броская яркая (оранжевая по умолчанию)
Badge.DecorativeVariations.modestlyCatchyBright- Умеренно броская яркая (жёлтая по умолчанию)
Badge.DecorativeVariations.neutralBright- Нейтральная яркая (голубая по умолчанию)
Badge.DecorativeVariations.modestlyCalmingBright- Умеренно успокаивающая яркая (синяя по умолчанию)
Badge.DecorativeVariations.calmingBright- Успокаивающая яркая (зелёная по умолчанию)
Badge.DecorativeVariations.achromaticBright- Ахроматическая яркая (тёмно-серая по умолчанию)
Badge.DecorativeVariations.veryCatchyPastel- Очень броская пастельная (красная по умолчанию)
Badge.DecorativeVariations.catchyPastel- Броская пастельная (оранжевая по умолчанию)
Badge.DecorativeVariations.modestlyCatchyPastel- Умеренно броская пастельная (жёлтая по умолчанию)
Badge.DecorativeVariations.neutralPastel- Нейтральная пастельная (голубая по умолчанию)
Badge.DecorativeVariations.modestlyCalmingPastel- Умеренно успокаивающая пастельная (синяя по умолчанию)
Badge.DecorativeVariations.calmingPastel- Успокаивающая пастельная (зелёная по умолчанию)
Badge.DecorativeVariations.achromaticPastel- Ахроматическая пастельная (светло-серая по умолчанию)
- Декоративные модификаторы
Badge__YDF.DecorativeModifiers.bordersDisguising- Эффект отсутствия обводки без изменения размеров
Badge__YDF.DecorativeModifiers.noBackground- Без заливки
- Loading placeholder
- Недоступен
Класс Badge
Vue-свойства
- keyLabel
- Русскоязычное наименование
- Надпись-ключ
- Тип
- string
- Запрещён ли undefined
- Нет
- Запрещён ли null
- Да
- Минимум символов
- 1
- valueLabel
- Русскоязычное наименование
- Надпись-значение
- Тип
- string
- Запрещён ли undefined
- Да
- Запрещён ли null
- Да
- Минимум символов
- 1
- theme
- Русскоязычное наименование
- Тема
- Тип
- string
- Замещение значения undefined
- Badge.Themes.regular
- Запрещён ли null
- Да
- Допустимые варианты
- Badge.Themes.regular
- (Любые, определённые через `Badge.defineThemes(themesNames)`)
- areThemesCSS_ClassesCommon
- Русскоязычное наименование
- Являются ли CSS-классы тем общими для всех компонентов
- Тип
- boolean
- Замещение значения undefined
- Badge.areThemesCSS_ClassesCommon
- Запрещён ли null
- Да
- geometricVariation
- Русскоязычное наименование
- Геометрическая вариация
- Тип
- string
- Замещение значения undefined
- Badge.GeometricVariations.regular
- Запрещён ли null
- Да
- Допустимые варианты
- Badge.GeometricVariations.regular
- Badge.GeometricVariations.small
- (Любые, определённые через `Badge.defineGeometricVariations(geometricVariationsNames)`)
- geometricModifiers
- Русскоязычное наименование
- Геометрические модификаторы
- Тип
- индексный массив
- Замещение значения undefined
- []
- Запрещён ли null
- Да
- Запрещены ли элементы типа undefined
- Да
- Запрещены ли элементы типа null
- Да
- Элементы массива
- Тип
- string
- Допустимые варианты
- Badge.GeometricModifiers.pillShape
- Badge.GeometricModifiers.singleLine
- decorativeVariation
- Русскоязычное наименование
- Декоративная вариация
- Тип
- string
- Запрещён ли undefined
- Да
- Запрещён ли null
- Да
- Допустимые варианты
- Badge.DecorativeVariations.veryCatchyBright
- Badge.DecorativeVariations.catchyBright
- Badge.DecorativeVariations.modestlyCatchyBright
- Badge.DecorativeVariations.neutralBright
- Badge.DecorativeVariations.modestlyCalmingBright
- Badge.DecorativeVariations.calmingBright
- Badge.DecorativeVariations.achromaticBright
- Badge.DecorativeVariations.veryCatchyPastel
- Badge.DecorativeVariations.catchyPastel
- Badge.DecorativeVariations.modestlyCatchyPastel
- Badge.DecorativeVariations.neutralPastel
- Badge.DecorativeVariations.modestlyCalmingPastel
- Badge.DecorativeVariations.calmingPastel
- Badge.DecorativeVariations.achromaticPastel
- (Любые, определённые через `Badge.defineDecorativeVariations(decorativeVariationsNames)`)
- decorativeModifiers
- Русскоязычное наименование
- Декоративные модификаторы
- Тип
- индексный массив
- Замещение значения undefined
- []
- Запрещён ли null
- Да
- Запрещены ли элементы типа undefined
- Да
- Запрещены ли элементы типа null
- Да
- Элементы массива
- Тип
- string
- Допустимые варианты
- Badge.DecorativeModifiers.bordersDisguising
- Badge.DecorativeModifiers.noBackground
- rootElementTag
- Русскоязычное наименование
- Тэг корневого элемента
- Тип
- string
- Замещение значения undefined
- "span"
- Запрещён ли null
- Да
- Минимум символов
- 1