ValidatableControlShell (Vue)
Эта страница не завершена
Приносим свои извинения, но данная страница ещё не завершена.
Такие элементы ввода, как однострочное текстовое поле (ValidatableControlShell(type="text")), многострочное текстовое ввода (textarea), выпадающие список (select) и так далее обычно употребляются не по одиночке, в окружении вспомогательных элементов:
- Заголовочная надпись (обычно элемент
label) - Комментарий (например, «тире и скобки можно необязательны» для поля ввода номера телефона)
- Метки «обязательное» или «необязательное»
- Сообщения валидации
Согласно одному из принципов качественного дизайна, все эти элементы окружения должны быть выполнены в едином стиле, потому появляется потребность в шаблонном компоненте, содержимое которого будет окружать элемент ввода. В YDF таким компонентом является ValidatableControlShell — в дословном переводе: «оболочка валидируемого компонента». Как следует из названия, данный компонент не является самостоятельным, а должен входить в состав других компонентов, а точнее быть для них оболочкой.
- Сам
ValidatableControlShellне является валидируемым компонентом, поскольку он лишь отображает переданные ему сообщения валидации, но при этом сам ничего не валидирует, так как валидация — задача основного компонента, которыйValidatableControlShellокружает. - При выборе названия избегалось слово «обёртка» («wrapper»), так как оно гораздо более многозначное, чем «оболочка». Так, по отношению к компонентам пользовательского интерфейса «обёртка» может означать не только буквальное обёртывание основного компонента с обеих сторон своими элементами, но и расширение функциональности основного компонента.
Краткий обзор
- Класс компонента
ValidatableControlShell- Live template-ы Vue-компонента (официальный плагин для семейства сред разработки IntelliJ IDEA)
- Наподобие автодополнения
- Pug-синтаксис
ValidatableControlShell--YDF-Vue-Pug- HTML-синтаксис
ValidatableControlShell--YDF-Vue-HTML
- Сокращённый
- Pug-синтаксис
vsc-ydf-vue-pug- HTML-синтаксис
vsc-ydf-vue-html
- Stylus-примесь для генерации стилей
generateValidatableControlShellYDF_GUI_ComponentStyles- Готовые темы
ValidatableControlShell.Themes.regular- Базовая (по умолчанию)
- Готовые геометрические вариации
ValidatableControlShell.GeometricVariations.regular- Базовая (по умолчанию)
ValidatableControlShell.GeometricVariations.small- Компактная
- Готовые декоративные вариации
ValidatableControlShell.DecorativeVariations.regular- Базовая (по умолчанию)
- Loading placeholder
- Недоступен
Класс ValidatableControlShellClass
Vue-свойства
ValidatableControlShell.Properties
{
- label
- Русскоязычное наименование
- Заголовочная надпись
- Тип
- string
- Запрещён ли undefined
- Нет
- Запрещён ли null
- Да
- Минимум символов
- 1
- guidance
- Русскоязычное наименование
- Комментарий
- Тип
- string
- Запрещён ли undefined
- Нет
- Запрещён ли null
- Да
- Минимум символов
- 1
- required
- Русскоязычное наименование
- Является ли ввод обязательным
- Тип
- boolean
- Замещение значения undefined
- false
- Запрещён ли null
- Да
- mustDisplayAppropriateBadgeIfInputIsRequired
- Русскоязычное наименование
- Нужно ли отображать надпись «обязательное» когда ввод обязателен
- Тип
- boolean
- Замещение значения undefined
- false
- Запрещён ли null
- Да
- mustDisplayAppropriateBadgeIfInputIsOptional
- Русскоязычное наименование
- Нужно ли отображать надпись «необязательное» когда ввод необязателен
- Тип
- boolean
- Замещение значения undefined
- false
- Запрещён ли null
- Да
- mustAddInvisibleBadgeForHeightEqualizingWhenNoBadge
- Русскоязычное наименование
- Нужно ли добавлять невидимый значок для выравнивание высоты
- Тип
- boolean
- Замещение значения undefined
- false
- Запрещён ли null
- Да
- coreElementHTML_ID
- Русскоязычное наименование
- HTML-идентификатор элемента-ядра
- Тип
- string
- Запрещён ли undefined
- Нет
- Запрещён ли null
- Да
- Минимум символов
- 1
- labelElementHTML_ID
- Русскоязычное наименование
- HTML-идентификатор заголовочной надписи
- Тип
- string
- Запрещён ли undefined
- Нет
- Запрещён ли null
- Да
- Минимум символов
- 1
- mainSlotWrapperAdditionalCSS_Classes
- Русскоязычное наименование
- CSS-классы основного слота
- Тип
- индексный массив
- Замещение значения undefined
- []
- Запрещён ли null
- Да
- Запрещены ли элементы типа undefined
- Да
- Запрещены ли элементы типа null
- Да
- Элементы массива
- Тип
- string
- Минимум символов
- 1
- theme
- Русскоязычное наименование
- Тема
- Тип
- string
- Замещение значения undefined
- ValidatableControlShell.Themes.regular
- Запрещён ли null
- Да
- Допустимые варианты
- ValidatableControlShell.Themes.regular
- (Любые, определённые через `ValidatableControlShell.defineThemes(themesNames)`)
- areThemesCSS_ClassesCommon
- Русскоязычное наименование
- Являются ли CSS-классы тем общими для всех компонентов
- Тип
- boolean
- Замещение значения undefined
- ValidatableControlShell.areThemesCSS_ClassesCommon
- Запрещён ли null
- Да
- geometricVariation
- Русскоязычное наименование
- Геометрическая вариация
- Тип
- string
- Замещение значения undefined
- ValidatableControlShell.GeometricVariations.regular
- Запрещён ли null
- Да
- Допустимые варианты
- ValidatableControlShell.GeometricVariations.regular
- ValidatableControlShell.GeometricVariations.small
- (Любые, определённые через `ValidatableControlShell.defineGeometricVariations(geometricVariationsNames)`)
- decorativeVariation
- Русскоязычное наименование
- Декоративная вариация
- Тип
- string
- Замещение значения undefined
- ValidatableControlShell.DecorativeVariations.regular
- Запрещён ли null
- Да
- Допустимые варианты
- ValidatableControlShell.DecorativeVariations.regular
- (Любые, определённые через `ValidatableControlShell.defineDecorativeVariations(decorativeVariationsNames)`)