0.0.6 • Published 2 years ago

@neirokin/egal-togglers-widgets-dev v0.0.6

Weekly downloads
-
License
-
Repository
-
Last release
2 years ago

egal-widgets: Togglers

Этот пакет включает в себя такие компоненты, как:

  • Кнопка
  • Чекбокс
  • Радио кнопка
  • Переключатель (toggle)

Кнопка

Параметы

ПараметрТипПо умолчаниюВозможные значенияОписание
disabledBooleanfalsetrue, falseСостояние кнопки (включена/выключена)
roundedBooleanfalsetrue, falseВнешний вид кнопки (круглые/обычные углы )
sizeStringmdsm, md, lgРазмер кнопки
softColorsBooleanfalsetrue, falseЦветовая схема кнопки
leftIconString-Любое имя иконки, которое есть в Bootstrap (circle-fill, chevron-right, и т.д.)Иконка слева. Если значение пустое, то иконка не отображается
rightIconString-Любое имя иконки, которое есть в Bootstrap (circle-fill, chevron-right, и т.д.)Иконка справа. Если значение пустое, то иконка не отображается
styleConfigObject{}{ backgroundColor: 'black' hover: { backgroundColor: ''white } }Объект для кастомизации. Использует объектный синтаксис Vue для inline-стилей Дополнительно добавлена обработка свойств с именем состояний (hover, active, disabled)

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

Чтобы кастомизировать кнопку, нужно передать в styleConfig объект в виде:

Использует нативные события кнопки

{
  backgroundColor: 'red',
  hover: {
    backgroundColor: 'green'
  },
  active: {
    backgroundColor: 'blue',
  },
  disbled: {
    backgroundColor: 'gray',
  },
}

hover, active и disabled устанавливают стили для соответсвтующих состояний

Чекбокс

Параметры

ПараметрТипПо умолчаниюВозможные значенияОписание
checkedBooleanfalsetrue, falseСтандартный параметр отвечающий за значение чекбокса (отмечен/ не отмечен)
disabledBooleanfalsetrue, falseСостояние чекбокса (включена/выключена)
sizeStringmdsm, md, lgРазмер чекбокса
checkboxRightBooleanfalsetrue, falseРасположение чекбокса относительно лэйбла (false - чекбокс слева, true - чекбокс справа )
labelStyleObject{}Inline-стили,допустимые VueОбъект для кастомизации лэйбла чекбокса
inputStyleObject{}{ backgroundColor: 'black' hover: { backgroundColor: ''white } }Объект для кастомизации чекбокса. Использует объектный синтаксис Vue для inline-стилей Дополнительно добавлена обработка свойств с именем состояний (hover, active, disabled). Кастомизируются только border-color и background-color!

События

НазваниеТип параметровОписание
changeBooleanВызывается при нажатии на чекбокс. Передаёт булево значение

Радиокнопка

Параметры

ПараметрТипПо умолчаниюВозможные значенияОписание
nameString-Любая строкаСтандартный парамет радиокнопки. Используется для группировки радиокнопок (см. Создание группы радиокнопок - MDN)
checkedBooleanfalsetrue, falseСтандартный параметр отвечающий за состояние радиокнопки (отмечен/ не отмечен)
disabledBooleanfalsetrue, falseСостояние радикнопки (включена/выключена)
valueString-Любая строкаСтандартный параметр радиокнопки. Значение радиокнопки
sizeStringmdsm, md, lgРазмер радиокнопки
radioRightBooleanfalsetrue, falseРасположение радиокнопки относительно лэйбла (false - радиокнопка слева, true - радиокнопка справа )
labelStyleObject{}Inline-стили,допустимые VueОбъект для кастомизации лэйбла радиокнопки
inputStyleObject{}{ backgroundColor: 'black' hover: { backgroundColor: ''white } }Объект для кастомизации радикнопки. Использует объектный синтаксис Vue для inline-стилей Дополнительно добавлена обработка свойств с именем состояний (hover, active, disabled). Кастомизируются только border-color и background-color!

События

НазваниеТип параметровОписание
changeStringВызывается при нажатии на радиокнопку. Передаёт value

Переключатель (toggler)

Параметры

ПараметрТипПо умолчаниюВозможные значенияОписание
activeBooleanfalsetrue, falseСтандартный параметр отвечающий за состояние переключателя (активный/ неактивный)
disabledBooleanfalsetrue, falseСостояние переключателя (включена/выключена)
sizeStringmdsm, md, lgРазмер переключателя
toggleRightBooleanfalsetrue, falseРасположение переключателся относительно лэйбла (false - переключатель слева, true - переключатель справа )
labelStyleObject{}Inline-стили,допустимые VueОбъект для кастомизации лэйбла переключателя
inputStyleObject{}{ backgroundColor: 'black' hover: { backgroundColor: ''white } }Объект для кастомизации переключателя. Использует объектный синтаксис Vue для inline-стилей Дополнительно добавлена обработка свойств с именем состояний (hover, active, disabled). Кастомизируются только border-color и background-color!

События

НазваниеТип параметровОписание
changeBooleanВызывается при нажатии на переключатель. Передаёт булево значение
0.0.6

2 years ago

0.0.5

2 years ago

0.0.4

2 years ago

0.0.3

2 years ago

0.0.2

2 years ago

0.0.1

2 years ago

0.1.0

2 years ago