Перейти к основному содержимому

Icon

Отображает значок из файла, которому присвоен псевдоним в файле Static.asset проекта

Файл, содержащий значок, может иметь только SVG-формат. Размер значка предопределен и может быть указан с помощью одного из свойств компонента. Цвет значка определяется значением RGBA, HEX, константой или значением из палитры согласно дизайн-системе Платформы. Также может быть задан цвет при наведении указателя мыши. На значке может быть указано значение счетчика.

<Icon 
  Name="person"  
  Color={"VIOLET_5"} 
  Counter="Не только цифры" 
  Size="ExtraLarge" 
  CSS={['m-8']} 
/>

Свойства​

Badge​

Количественная информация в компонентах Menu, Accordion, Link, Text.

В качестве значения может использоваться объект с полями: counter (число), position ("post" или "pre"), color (цвет)

Тип: any

CSS​

Массив строк-классов CSS-стилей, описанных в файле CSS.css разрабатываемого проекта или встроенных CSS-стилей Платформы.

Пример:

// внешние (m) и внутренние (p) отступы для компонента. Число после символа "-" (в этом примере - 4) должно быть кратно величине, указанной в параметре, определяющем кратность отступов, в файле Style.mdtheme разрабатываемого проекта.
CSS={["m-4", "p-4"]}

Тип: array

Color​

Цвет: значение RGBA или значение из палитры согласно дизайн-системе Платформы, например, MAIN_5.

Тип: string

CombineConfig​

Служебное свойство, используемое в визуальном режиме Редактора Форм, для присваивания значений свойствам компонента в виде генерируемых блоков кода. Запрещено изменять значение.

Тип: object

Counter​

Счетчик: строка, содержащая число или текст.

Тип: string

CustomHeight​

Высота в пикселях (используется по умолчанию), процентах или значение auto.

Тип: string

Значение по умолчанию: 16px

CustomWidth​

Ширина в пикселях (используется по умолчанию), процентах или значение auto.

Тип: string

Значение по умолчанию: 16px

Hidden​

Признак состояния компонента Скрыт.

Тип: boolean

Hint​

Текст, отображаемый при наведении указателя мыши на компонент. Текст отображается на белом фоне

Тип: any

HoveredColor​

Цвет при наведении указателя мыши: значение RGBA или значение из палитры согласно дизайн-системе Платформы, например, MAIN_5.

Тип: string

Id​

Идентификатор компонента для навигации к нему на HTML-странице. Подробнее см. HTML id Attribute или ID

Тип: string

Name​

Псевдоним значка из файла Static.asset.

Тип: string

NoResizeSVG​

Признак использования SVG-изображения существующего размера; применяется для совместимости с версиями Платформы v. 0.6 и более ранними.

Тип: boolean

OnClick​

Обработчик события нажатия левой кнопки мыши, когда указатель мыши находится на компоненте.

В качестве параметра принимает объект типа объект события компонента экранной формы с дополнительными полями типа MouseEvent.

Пример:

OnClick={() => {
  // Получение параметра события
  const event = getEvent();
  // Вывод параметра события в консоль браузера
  console.log(event);
  }
}

Тип: undefined

OnKeyDown​

Обработчик события нажатия любой клавиши клавиатуры. В качестве параметра принимает объект типа объект события компонента экранной формы с дополнительными полями типа KeyboardEvent.

Пример:

OnKeyDown={() => {
  // Получение параметра события
  const event = getEvent();
  // Вывод параметра события в консоль браузера
  console.log(event);
  }
}

Тип: undefined

OnKeyUp​

Обработчик события отпускания любой клавиши клавиатуры. В качестве параметра принимает объект типа объект события компонента экранной формы с дополнительными полями типа KeyboardEvent.

Пример:

OnKeyUp={() => {
  // Получение параметра события
  const event = getEvent();
  // Вывод параметра события в консоль браузера
  console.log(event);
  }
}

Тип: undefined

OnMouseDown​

Обработчик события нажатия любой кнопки мыши, когда указатель мыши находится на компоненте. В качестве параметра принимает объект типа объект события компонента экранной формы с дополнительными полями типа MouseEvent.

Пример:

OnMouseDown={() => {
  // Получение параметра события
  const event = getEvent();
  // Вывод параметра события в консоль браузера
  console.log(event);
  }
}

Тип: undefined

OnMouseEnter​

Обработчик события перемещения указателя мыши на компонент. Событие срабатывает только в случае, если указатель мыши находится за пределами компонента и пользователь перемещает указатель мыши внутрь компонента. Если указатель мыши в текущий момент находится внутри компонента, для срабатывания события пользователь должен переместить указатель мыши за пределы компонента, а затем обратно внутрь компонента. В качестве параметра принимает объект типа объект события компонента экранной формы с дополнительными полями типа MouseEvent.

Пример:

OnMouseEnter={() => {
  // Получение параметра события
  const event = getEvent();
  // Вывод параметра события в консоль браузера
  console.log(event);
  }
}

Тип: undefined

OnMouseLeave​

Обработчик события перемещения указателя мыши за пределы компонента. Событие срабатывает, только если указатель мыши находится внутри компонента, а пользователь перемещает указатель мыши за пределы компонента. Если указатель мыши в текущий момент находится за пределами компонента, для срабатывания события пользователь должен переместить указатель мыши внутрь компонента, а затем обратно за пределы компонента. В качестве параметра принимает объект типа объект события компонента экранной формы с дополнительными полями типа MouseEvent.

Пример:

OnMouseLeave={() => {
  // Получение параметра события
  const event = getEvent();
  // Вывод параметра события в консоль браузера
  console.log(event);
  }
}

Тип: undefined

OnMouseMove​

Обработчик события наведения указателя мыши на компонент. В качестве параметра принимает объект типа объект события компонента экранной формы с дополнительными полями типа MouseEvent.

Пример:

OnMouseMove={() => {
  // Получение параметра события
  const event = getEvent();
  // Вывод параметра события в консоль браузера
  console.log(event);
  }
}

Тип: undefined

OnMouseOut​

Обработчик события перемещения указателя мыши за пределы компонента. Когда пользователь наводит указатель мыши на компонент, происходит одно событие MouseOver, за которым следует одно или несколько событий MouseMove, когда пользователь перемещает указатель мыши внутри компонента. Одно событие MouseOut возникает, когда пользователь выводит указатель мыши за пределы компонента. В качестве параметра принимает объект типа объект события компонента экранной формы с дополнительными полями типа MouseEvent.

Пример:

OnMouseOut={() => {
  // Получение параметра события
  const event = getEvent();
  // Вывод параметра события в консоль браузера
  console.log(event);
  }
}

Тип: undefined

OnMouseOver​

Обработчик события перемещения указателя мыши на компонент. Событие возникает, когда пользователь наводит указатель мыши на компонент, и не повторяется до тех пор, пока пользователь не выведет указатель мыши за пределы компонента и затем не вернет его обратно. В качестве параметра принимает объект типа объект события компонента экранной формы с дополнительными полями типа MouseEvent.

Пример:

OnMouseOver={() => {
  // Получение параметра события
  const event = getEvent();
  // Вывод параметра события в консоль браузера
  console.log(event);
  }
}

Тип: undefined

OnMouseUp​

Обработчик события отпускания кнопки мыши, когда указатель мыши находится на компоненте. В качестве параметра принимает объект типа объект события компонента экранной формы с дополнительными полями типа MouseEvent.

Пример:

OnMouseUp={() => {
  // Получение параметра события
  const event = getEvent();
  // Вывод параметра события в консоль браузера
  console.log(event);
  }
}

Тип: undefined

OnUnmount​

Обработчик события размонтирования согласно жизненному циклу экранной формы. Не имеет параметров.

Пример:

OnUnmount={() => {
  // Отмена выполнения периодического действия при размонтировании экранной формы
    return clearInterval(getValue("pleerInterval"))
  }
}

Тип: undefined

Size​

Размер значка в пикселях.

Тип: enum

Значение по умолчанию: Medium

Возможные значения:

ExtraSmall - 8x8 Small - 16x16 Medium - 24x24 Large - 32x32 ExtraLarge - 48x48 Custom - Произвольное значение из CustomWidth и CustomHeight

Slot​

Именованное пространство во фрагменте экранной формы или именованное пространство в шаблоне компонента с возможностью шаблонизации, например, Select, DataGrid.

Тип: string

Tooltip​

Текст, отображаемый при наведении указателя мыши на компонент. Текст отображается на черном фоне.

Тип: any

TraceId​

Идентификатор для отслеживания состояния компонента исходя из жизненного цикла экранной формы. Используется для выполнения фрагмента кода по изменению состояния компонента

Тип: string

Value​

Устаревшее свойство. Используется для псевдонима значка, указания размера и управления отображением счетчика. Для указания размера используется свойство Size с одним из значений: ExtraSmall, Small, Medium, Large. По умолчанию используется размер Medium. Для задания цвета значка используется свойство Color. Для отображения счетчика используется свойство Counter, например, { name: "person", counter: 2 }.

Тип: object

Visible​

Признак инверсии состояния компонента Скрыт.

Тип: boolean

Значение по умолчанию: True

Примеры​

JSX:

<Group Mode="Column">
  // устаревшее свойство Value!
  <Icon Value={{ name: 'menubar',}} Color={"VIOLET_5"} CSS={['m-8']} />
  <Icon Value={{ name: 'filter',}} Color={"ERROR_6"} CSS={['m-8']} />
  
  // Новые свойства Name, Counter, Size
  <Icon Name="person" Counter="2" CSS={['m-8']} />
  <Icon Name="person" Counter="Не только цифры" Size="ExtraLarge" CSS={['m-8']} />
  
  // Совместимость с отображением в версиях Платформы до v. 0.6 (неизменяемый размер SVG)
  <Icon NoResizeSVG={true}  Value={{ name: 'filter'}} Counter="12" CSS={['m-8']} />
  
  // новая возможность настройки размера значка
  <Icon 
    Name="person" 
    Size="Custom" 
    CustomHeight="100px" 
    CustomWidth="100px" 
    CSS={['m-8']} 
  />
  
  // пример отображения круглого значка с помощью Group
  <Group 
    CSS={['m-8']} 
    Align="Center" 
    VerticalAlign="Center" 
    Background="VIOLET_3" 
    HoveredBackground="VIOLET_5" 
    BorderRadius="100%" 
    Width="30px" 
    Height="30px"
    Cursor="Not-allowed"
  >
    <Icon 
      Name="person" 
      Color="VIOLET_5" 
      HoveredColor="VIOLET_3" 
    />
  </Group>
</Group>