import { Subject } from 'rxjs'; import { BaseModel, BoundingBoxRectModel, ComponentType, EdgeEnum, OptionalType, FontWeightEnum, BorderStyleEnum, TextAlignmentEnum, ContextualStyleEnum, SizeEnum, AuthService, PortalOutletAttachedType } from '@itix/core'; import { ButtonClickEvent } from './button-click.event'; /** * Representa um botão. */ export declare class ButtonConfig extends BaseModel { /** * ID do botão. */ id?: string; /** * Texto descritivo do botão. */ text?: string; /** * Nome do botão. */ name?: string; /** * Tipo. * submit, button, etc. */ type: string; /** * Se informado, exibe apenas se o usuário logado tiver acesso à alguma das claims. */ allowedClaims: string[]; /** * Estilo de cores do botão, seguindo o padrão de cores. * Veja: #ixsee[p:models/enums, i:ContextualStyleEnum, l:core]. */ style?: ContextualStyleEnum | undefined; /** * Estilo de cores do botão quando o mesmo está ativo, seguindo o padrão de cores. * Veja: #ixsee[p:models/enums, i:ContextualStyleEnum, l:core]. */ activeStyle?: ContextualStyleEnum; /** * Estilo de cores aplicados ao texto do botão, seguindo o padrão de cores. * Veja: #ixsee[p:models/enums, i:ContextualStyleEnum, l:core]. */ textStyle?: ContextualStyleEnum; /** * Estilo de cores aplicados ao no hover do botão, seguindo o padrão de cores. * Veja: #ixsee[p:models/enums, i:ContextualStyleEnum, l:core]. */ hoverStyle?: ContextualStyleEnum; /** * Estilo dos cantos do botão. Podendo ser no formato arredondado, quadrado ou de pílula. * Veja: #ixsee[p:models/enums, i:BorderStyleEnum, l:core]. */ borderStyle: BorderStyleEnum; /** * Indica o peso da fonte aplicada ao texto do botão (Veja: #ixsee[p:models/enums, i:FontWeightEnum, l:core]). */ fontWeight: FontWeightEnum; /** * Tamanho do botão (Veja: #ixsee[p:models/enums, i:SizeEnum, l:core]). */ size?: SizeEnum | undefined; /** * Alinhamento horizontal do texto (Veja: #ixsee[p:models/enums, i:TextAlignmentEnum, l:core]). */ textAlignment?: TextAlignmentEnum; /** * Ícone exibido antes do texto do botão, seguindo o padrão font-awesome - fa(x) - fa-(icon), * onde: x é a variação do ícones, podendo ser solid - fas, light - fal, regular - far, duotone - fad * e icon é o nome do ícone do font-awesome. Ex: fal fa-home */ iconClass?: string; /** * Em qual borda o ícone, se existir, será inserido (Veja: #ixsee[p:models/enums, i:EdgeEnum, l:core]). */ iconPosition: EdgeEnum; /** * Indica se o botão inteiro é um ícone. E não possuirá texto. */ isIconButton: boolean; /** * Indica se a cor do botão será mais clara do que o definido para o estilo dele. */ isLight: boolean; /** * Indica se a cor do botão será mais clara do que o definido para o tipo dele, quando for passado o mouse em cima. */ isLightOnHover: boolean; /** * Indica se o botão tem apenas o contorno. * Quando "falso", o botão será preenchido por cor de fundo, de acordo com o seu estilo. */ isOutline: boolean; /** * Indica se o botão ocupará todo espaço em tela. */ isBlock: boolean; /** * Indica se será aplicado uma sombra no botão. */ isShadowed: boolean; /** * Indica se será aplicado uma sombra no botão quando o mouse passar por cima dele. */ isShadowedOnHover: boolean; /** * Indica se o botão está visível. */ isVisible: boolean; /** * Indica se o botão está desabilitado. */ isDisabled?: boolean; /** * Indica se a ação está sendo executada. */ isLoading: boolean; /** * Indica se o botão possuirá borda. Utilizado apenas quando o estilo não for "Outline". */ hasBorder: boolean; /** * Não dispara o evento de click quando o botão for do tipo Toggle estiver 'Ativo'. */ preventClickWhenActive: boolean; /** * Indica se o botão está ativo (pressionado). */ isActive?: boolean; /** * Indica se o botão é um toggle. De modo que ao ser clicado, o valor do seu estado "Ativo" é alternado. */ isToggle?: boolean; /** * Indica se deve desabilitar o botão em vez de removê-lo, quando ele não tiver permissão (allowedClaims). */ disableIfNotAllowed: boolean; /** * Texto descritivo do conteúdo do botão. */ tooltip?: string; /** * Ícone de carregamento. * Seguindo o padrão font-awesome - fa(x) - fa-(icon), * onde: x é a variação do ícones, podendo ser solid - fas, light - fal, regular - far, duotone - fad * e icon é o nome do ícone do font-awesome. Ex: fal fa-home. */ loadingIconClass: string; /** * Classes CSS externas aplicada ao componente. Separe as classes por espaço. Ex.: "class-1 class-2" */ customClasses: string; /** * Texto a ser exibido durante execução. * Caso não seja informado, utiliza o texto padrão. */ loadingText?: string; /** * Lista de botões que compõem o dropdown do componente. */ dropdownItems: ButtonConfig[]; /** * Indica se deve exibir a seta nos dropdowns. */ showDropdownArrow: boolean; /** * Indica se deve exibir o botão de fechar em dropdowns com template. */ showDropdownCloseButton: boolean; /** * Indica se deve fechar o dropdown ao efetuar qualquer clique do mouse. */ closeDropdownOnClick?: boolean | undefined; /** * Parâmetros customizados que são enviados ao clicar no botão. */ extraData: any[]; /** * Atualiza o texto do botão por observable. */ textSubject?: Subject; /** * Atualiza o ícone do botão por observable. */ iconClassSubject?: Subject; /** * Indica se o botão está desabilitado por observable. */ isDisabledSubject?: Subject; /** * Indica se o botão está visível por observable. */ isVisibleSubject?: Subject; /** * Atualiza os itens do dropdown através do observable. */ dropdownItemsSubject?: Subject; /** * Função executada toda vez que o dropdown é aberto. */ onDropdownOpened?: (btn: ButtonConfig) => void; /** * Função executado ao fechar o dropdown. */ onDropdownClosed?: (btn: ButtonConfig) => void; /** * Função executada toda vez que o dropdown customizado é criado (Veja: #ixsee[p:models/types, i:PortalOutletAttachedType, l:core]). */ onCustomDropdownCreated?: (outlet: PortalOutletAttachedType) => void; /** * Armazena a referência do botão pai do subDropDown. */ parent?: ButtonConfig; /** * Indica se é um separador. Ele é usado em itens do dropdown. */ isSeparator?: boolean; /** * Indica se é um cabeçalho. Ele é usado em itens do dropdown. */ isHeader?: boolean; /** * Função executada ao clicar no botão (Veja: #ixsee[p:common/button/models, i:ButtonClickEvent]). * **Obs:** Só é necessária quando a classe é instanciada diretamente. * Ex: em grupos de botões (#ixsee[p:common/button/models, i:ButtonGroupModel]) */ clickFunction?: (event: ButtonClickEvent) => void; /** * Função executada toda vez que o mouse passa por cima do botão. */ onMouseOver?: (btn: ButtonConfig) => void; /** * Template a ser exibido como menu no dropdown. */ dropdownComponent?: ComponentType; /** * Se houver dropdown, indica se ele está aberto. */ isDropdownOpen: boolean; /** * Se houver dropdown, indica se ele está renderizado tanto em tamanho quanto em posicionamento na tela. */ isDropdownRendered: boolean; /** * Indica se o botão é um subDropdown. */ isSubDropdown?: boolean; /** * Indica se o botão é um dropdown. */ isDropdown?: boolean; /** * Indica se o botão é um item de dropdown. */ isDropdownItem?: boolean; /** * Indica se deve desabilitar o botão após o clique, até a requisição associada a ele finalizar. */ disableUntilRequestFinished?: boolean; /** * Coordenadas de onde deve ser exibido o dropdown do botão. * Veja: #ixsee[p:models/position, i:BoundingBoxRectModel, l:core]. */ dropdownCoordinates: BoundingBoxRectModel; /** * Verifica se o botão tem um dropdown customizado. */ get hasCustomDropdown(): boolean; /** * Verifica se o botão está atualmente desabilitado. */ get isCurrentlyDisabled(): OptionalType; /** * Obtém o tipo de toggle, se existir. Podendo ser toggle de Button ou de Dropdown */ get toggle(): OptionalType; /** * Classes CSS padrão do botão que são geradas com base nos valores informados no model, como estilo, tamanhoe tipo. */ get classes(): string[]; private subscriptions; constructor(init: Partial); /** * Realiza as finalizações necessárias para a classe. */ dispose(): void; /** * Alterna o estado de ativo do botão. */ toggleActive(): void; /** * Alterna o estado do dropdown. */ toggleDropdown(): void; /** * Atualiza o estado do botão de acordo com as permissões do usuário. * @param authService Serviço de autenticação/autorização da XDK (Veja: #ixsee[p:abstractions, i:AuthService, l:core]). */ updateSecurityStatus(authService: AuthService): void; /** * Configura as subscriptions do botão. */ private setupSubscriptions; }