custom-card-helpers

Index

Enumerations

Type aliases

Variables

Type aliases

ActionConfig

ActionHandlerEvent

ActionHandlerEvent: HASSDomEvent<ActionHandlerDetail>

HapticType

Broadcast haptic feedback requests

LocalizeFunc

LocalizeFunc: (key: string, ...args: any[]) => string

Type declaration

- (key: string, ...args: any[]): string
- Parameters
  - key: string
  - Rest ...args: any[]
  Returns string

ValidHassDomEvent

ValidHassDomEvent: keyof HASSDomEvents

Variables

DEFAULT_DOMAIN_ICON

DEFAULT_DOMAIN_ICON: "hass:bookmark" = "hass:bookmark"

Icon to use when no icon specified for domain.

DEFAULT_PANEL

DEFAULT_PANEL: "lovelace" = "lovelace"

Panel to show when no panel is picked.

DEFAULT_VIEW_ENTITY_ID

DEFAULT_VIEW_ENTITY_ID: "group.default_view" = "group.default_view"

Entity ID of the default view.

DOMAINS_HIDE_MORE_INFO

DOMAINS_HIDE_MORE_INFO: string[] = ...

Domains that show no more info dialog.

DOMAINS_MORE_INFO_NO_HISTORY

DOMAINS_MORE_INFO_NO_HISTORY: string[] = ...

Domains that should have the history hidden in the more info dialog.

DOMAINS_TOGGLE

DOMAINS_TOGGLE: Set<string> = ...

Domains where we allow toggle in Lovelace.

DOMAINS_WITH_CARD

DOMAINS_WITH_CARD: string[] = ...

Domains that have a state card.

DOMAINS_WITH_MORE_INFO

DOMAINS_WITH_MORE_INFO: string[] = ...

Domains with separate more info dialog.

STATES_OFF

STATES_OFF: string[] = ...

States that we consider "off".

UNIT_C

UNIT_C: "°C" = "°C"

Temperature units.

UNIT_F

UNIT_F: "°F" = "°F"

fixedIcons

fixedIcons: { alert: string; automation: string; calendar: string; camera: string; climate: string; configurator: string; conversation: string; device_tracker: string; fan: string; group: string; history_graph: string; homeassistant: string; homekit: string; image_processing: string; input_boolean: string; input_datetime: string; input_number: string; input_select: string; input_text: string; light: string; mailbox: string; notify: string; person: string; plant: string; proximity: string; remote: string; scene: string; script: string; sensor: string; simple_alarm: string; sun: string; switch: string; timer: string; updater: string; vacuum: string; water_heater: string; weblink: string } = ...

Type declaration

alert: string
automation: string
calendar: string
camera: string
climate: string
configurator: string
conversation: string
device_tracker: string
fan: string
group: string
history_graph: string
homeassistant: string
homekit: string
image_processing: string
input_boolean: string
input_datetime: string
input_number: string
input_select: string
input_text: string
light: string
mailbox: string
notify: string
person: string
plant: string
proximity: string
remote: string
scene: string
script: string
sensor: string
simple_alarm: string
sun: string
switch: string
timer: string
updater: string
vacuum: string
water_heater: string
weblink: string

Functions

Const applyThemesOnElement

applyThemesOnElement(element: any, themes: any, localTheme: any, updateMeta?: boolean): void

- Defined in src/apply_themes_on_element.ts:9
Apply a theme to an element by setting the CSS variables on it.

element: Element to apply theme on. themes: HASS Theme information localTheme: selected theme. updateMeta: boolean if we should update the theme-color meta element.

Parameters
- element: any
- themes: any
- localTheme: any
- updateMeta: boolean = false
Returns void

Const computeCardSize

computeCardSize(card: LovelaceCard): number | Promise<number>

- Defined in src/compute-card-size.ts:3
Parameters
- card: LovelaceCard
Returns number | Promise<number>

computeDomain

computeDomain(entityId: string): string

- Defined in src/compute-domain.ts:1
Parameters
- entityId: string
Returns string

computeEntity

computeEntity(entityId: string): string

- Defined in src/compute-entity.ts:1
Parameters
- entityId: string
Returns string

computeRTL

computeRTL(hass: HomeAssistant): boolean

- Defined in src/compute-rtl.ts:3
Parameters
- hass: HomeAssistant
Returns boolean

computeRTLDirection

computeRTLDirection(hass: HomeAssistant): "rtl" | "ltr"

- Defined in src/compute-rtl.ts:11
Parameters
- hass: HomeAssistant
Returns "rtl" | "ltr"

computeStateDisplay

computeStateDisplay(localize: LocalizeFunc, stateObj: HassEntity, locale: FrontendTranslationData, state?: string): string

- Defined in src/compute-state-display.ts:10
Parameters
- localize: LocalizeFunc
- stateObj: HassEntity
- locale: FrontendTranslationData
- Optional state: string
Returns string

computeStateDomain

computeStateDomain(stateObj: HassEntity): string

- Defined in src/compute-state-domain.ts:4
Parameters
- stateObj: HassEntity
Returns string

Const createThing

createThing(cardConfig: any, isRow?: boolean): any

- Defined in src/create-thing.ts:38
Parameters
- cardConfig: any
- isRow: boolean = false
Returns any

Const debounce

debounce<T>(func: T, wait: number, immediate?: boolean): T

- Defined in src/debounce.ts:10
Returns a function, that, as long as it continues to be invoked, will not be triggered. It will be called after it stops being called for wait ms. This can be usefull for ResizeObservers for example.

Type parameters
- T: (...args: any[]) => unknown
Parameters
- func: T
  
  The function you want to debounce
- wait: number
  
  Period to wait in ms
- immediate: boolean = false
  
  Triggering on the leading edge instead of the trailing
Returns T
Debounced Function

domainIcon

domainIcon(domain: string, state?: string): string

- Defined in src/domain_icons.ts:48
Parameters
- domain: string
- Optional state: string
Returns string

durationToSeconds

durationToSeconds(duration: string): number

- Defined in src/datetime/duration_to_seconds.ts:1
Parameters
- duration: string
Returns number

Const evaluateFilter

evaluateFilter(stateObj: HassEntity, filter: any): boolean

- Defined in src/evaluate-filter.ts:3
Parameters
- stateObj: HassEntity
- filter: any
Returns boolean

Const fireEvent

fireEvent<HassEvent>(node: HTMLElement | Window, type: HassEvent, detail?: HASSDomEvents[HassEvent], options?: { bubbles?: boolean; cancelable?: boolean; composed?: boolean }): Event

- Defined in src/fire-event.ts:57
Dispatches a custom event with an optional detail value.

Type parameters
- HassEvent: keyof HASSDomEvents
Parameters
- node: HTMLElement | Window
- type: HassEvent
  
  Name of event type.
- Optional detail: HASSDomEvents[HassEvent]
  
  Detail value containing event-specific payload.
- Optional options: { bubbles?: boolean; cancelable?: boolean; composed?: boolean }
  - Optional bubbles?: boolean
  - Optional cancelable?: boolean
  - Optional composed?: boolean
Returns Event
The new event that was fired.

Const formatDate

formatDate(dateObj: Date, locales: FrontendTranslationData): string

- Defined in src/datetime/format_date.ts:14
Parameters
- dateObj: Date
- locales: FrontendTranslationData
Returns string

Const formatDateTime

formatDateTime(dateObj: Date, locales: FrontendTranslationData): string

- Defined in src/datetime/format_date_time.ts:14
Parameters
- dateObj: Date
- locales: FrontendTranslationData
Returns string

Const formatNumber

formatNumber(num: string | number, locale?: FrontendTranslationData, options?: NumberFormatOptions): string

- Defined in src/format-number.ts:9
Formats a number based on the specified language with thousands separator(s) and decimal character for better legibility.

Parameters
- num: string | number
  
  The number to format
- Optional locale: FrontendTranslationData
  
  The user-selected language and number format, from hass.locale
- Optional options: NumberFormatOptions
  
  Intl.NumberFormatOptions to use
Returns string

Const formatTime

formatTime(dateObj: Date, locales: FrontendTranslationData): string

- Defined in src/datetime/format_time.ts:14
Parameters
- dateObj: Date
- locales: FrontendTranslationData
Returns string

Const forwardHaptic

forwardHaptic(hapticType: HapticType): void

- Defined in src/haptic.ts:31
Parameters
- hapticType: HapticType
Returns void

Const getLovelace

getLovelace(): any

- Defined in src/get-lovelace.ts:1
Returns any

Const handleAction

handleAction(node: HTMLElement, hass: HomeAssistant, config: { camera_image?: string; double_tap_action?: ActionConfig; entity?: string; hold_action?: ActionConfig; tap_action?: ActionConfig }, action: string): void

- Defined in src/handle-action.ts:84
Parameters
- node: HTMLElement
- hass: HomeAssistant
- config: { camera_image?: string; double_tap_action?: ActionConfig; entity?: string; hold_action?: ActionConfig; tap_action?: ActionConfig }
  - Optional camera_image?: string
  - Optional double_tap_action?: ActionConfig
  - Optional entity?: string
  - Optional hold_action?: ActionConfig
  - Optional tap_action?: ActionConfig
- action: string
Returns void

Const handleActionConfig

handleActionConfig(node: HTMLElement, hass: HomeAssistant, config: { camera_image?: string; double_tap_action?: ActionConfig; entity?: string; hold_action?: ActionConfig; tap_action?: ActionConfig }, actionConfig: undefined | ActionConfig): void

- Defined in src/handle-action.ts:7
Parameters
- node: HTMLElement
- hass: HomeAssistant
- config: { camera_image?: string; double_tap_action?: ActionConfig; entity?: string; hold_action?: ActionConfig; tap_action?: ActionConfig }
  - Optional camera_image?: string
  - Optional double_tap_action?: ActionConfig
  - Optional entity?: string
  - Optional hold_action?: ActionConfig
  - Optional tap_action?: ActionConfig
- actionConfig: undefined | ActionConfig
Returns void

Const handleClick

handleClick(node: HTMLElement, hass: HomeAssistant, config: { camera_image?: string; double_tap_action?: ActionConfig; entity?: string; hold_action?: ActionConfig; tap_action?: ActionConfig }, hold: boolean, dblClick: boolean): void

- Defined in src/handle-click.ts:7
Parameters
- node: HTMLElement
- hass: HomeAssistant
- config: { camera_image?: string; double_tap_action?: ActionConfig; entity?: string; hold_action?: ActionConfig; tap_action?: ActionConfig }
  - Optional camera_image?: string
  - Optional double_tap_action?: ActionConfig
  - Optional entity?: string
  - Optional hold_action?: ActionConfig
  - Optional tap_action?: ActionConfig
- hold: boolean
- dblClick: boolean
Returns void

hasAction

hasAction(config?: ActionConfig): boolean

- Defined in src/has-action.ts:3
Parameters
- Optional config: ActionConfig
Returns boolean

hasConfigOrEntityChanged

hasConfigOrEntityChanged(element: any, changedProps: Map<string | number | symbol, unknown>, forceUpdate: Boolean): boolean

- Defined in src/has-changed.ts:6
Parameters
- element: any
- changedProps: Map<string | number | symbol, unknown>
- forceUpdate: Boolean
Returns boolean

hasDoubleClick

hasDoubleClick(config?: ActionConfig): boolean

- Defined in src/has-double-click.ts:4
Parameters
- Optional config: ActionConfig
Returns boolean

Const navigate

navigate(_node: any, path: string, replace?: boolean): void

- Defined in src/navigate.ts:12
Parameters
- _node: any
- path: string
- replace: boolean = false
Returns void

relativeTime

relativeTime(dateObj: Date, localize: LocalizeFunc, options?: { compareTime?: Date; includeTense?: boolean }): string

- Defined in src/datetime/relative_time.ts:11
Parameters
- dateObj: Date
- localize: LocalizeFunc
- options: { compareTime?: Date; includeTense?: boolean } = {}
  - Optional compareTime?: Date
  - Optional includeTense?: boolean
Returns string

secondsToDuration

secondsToDuration(d: number): null | string

- Defined in src/datetime/seconds_to_duration.ts:3
Parameters
- d: number
Returns null | string

Const stateIcon

stateIcon(state: HassEntity): any

- Defined in src/state_icon.ts:17
Parameters
- state: HassEntity
Returns any

timerTimeRemaining

timerTimeRemaining(stateObj: HassEntity): number

- Defined in src/datetime/timer_time_remaining.ts:4
Parameters
- stateObj: HassEntity
Returns number

Const toggleEntity

toggleEntity(hass: HomeAssistant, entityId: string): Promise<void>

- Defined in src/toggle-entity.ts:5
Parameters
- hass: HomeAssistant
- entityId: string
Returns Promise<void>

Const turnOnOffEntities

turnOnOffEntities(hass: HomeAssistant, entityIds: string[], turnOn?: boolean): void

- Defined in src/turn-on-off-entities.ts:5
Parameters
- hass: HomeAssistant
- entityIds: string[]
- turnOn: boolean = true
Returns void

Const turnOnOffEntity

turnOnOffEntity(hass: HomeAssistant, entityId: string, turnOn?: boolean): Promise<void>

- Defined in src/turn-on-off-entity.ts:4
Parameters
- hass: HomeAssistant
- entityId: string
- turnOn: boolean = true
Returns Promise<void>

Index

Enumerations

Interfaces

Type aliases

Variables

Functions

Type aliases

ActionConfig

ActionHandlerEvent

HapticType

LocalizeFunc

Type declaration

Parameters

key: string

Rest ...args: any[]

Returns string

ValidHassDomEvent

Variables

DEFAULT_DOMAIN_ICON

DEFAULT_PANEL

DEFAULT_VIEW_ENTITY_ID

DOMAINS_HIDE_MORE_INFO

DOMAINS_MORE_INFO_NO_HISTORY

DOMAINS_TOGGLE

DOMAINS_WITH_CARD

DOMAINS_WITH_MORE_INFO

STATES_OFF

UNIT_C

UNIT_F

fixedIcons

Type declaration

alert: string

automation: string

calendar: string

camera: string

climate: string

configurator: string

conversation: string

device_tracker: string

fan: string

group: string

history_graph: string

homeassistant: string

homekit: string

image_processing: string

input_boolean: string

input_datetime: string

input_number: string

input_select: string

input_text: string

light: string

mailbox: string

notify: string

person: string

plant: string

proximity: string

remote: string

scene: string

script: string

sensor: string

simple_alarm: string

sun: string

switch: string

timer: string

updater: string

vacuum: string

water_heater: string

weblink: string

Functions

Const applyThemesOnElement

Parameters

element: any

themes: any

localTheme: any

updateMeta: boolean = false

Returns void

Const computeCardSize

Parameters

card: LovelaceCard

Returns number | Promise<number>