UTILS

Index

Variables

propsToAttributes

Functions

Variables

propsToAttributes

• propsToAttributes(props: Record<string, unknown>): (Anonymous function)

Directive transformant des propriétés de types objet Record<string, unknown> en attribut compréhensible par lit-html et le tag html.

Cela est particulièrement utile dans le cas de données externes.

@author open-wc@ (open-wc). Adapdée à Wapitis

Comme toute directive, propsToAttributes est utilisé dans un tag html. Avec la syntaxe de lit-html, il est nécessaire de déclarer un attribut pour appliquer cette directive. Nous utilisons ici la convention ...=, bien que n’importe quel nom d’attibut puisse être utilisé. Exemple :

    html`
        <div ...="${propsToAttributes({ propertyA: 'a', propertyB: 'b' })}"></div>
    `

Parameters:

Name	Type	Description
`props`	Record<string, unknown>	Les propriétés à transformer

Returns: (Anonymous function)

Functions

camelCaseToDashCase

▸ camelCaseToDashCase(name: unknown): string

Defined in src/utils.ts:43

Transforme une chaîne du type camelCase en DashCase

Parameters:

Name	Type	Description
`name`	unknown	Chaîne à transformer

Returns: string

dashCaseToCamelCase

▸ dashCaseToCamelCase(name: unknown): string

Defined in src/utils.ts:53

Transforme une chaîne du type DashCase en camelCase

Parameters:

Name	Type	Description
`name`	unknown	Chaîne à transformer

Returns: string

dispatchEvent

▸ dispatchEvent(name: string, property: object, parent: HTMLElement): void

Defined in src/utils.ts:73

Envoie un customEvent sur l’élément parent, avec les propriétés renseignées dans property

Parameters:

Name	Type	Default	Description
`name`	string	-	Nom du custom Event
`property`	object	-	Propriétés à envoyer
`parent`	HTMLElement	document.body	Elément sur lequel le custom event est envoyé, document.body par défaut

Returns: void

fromString

▸ fromString(value: string | null, type?: unknown): *{ [name: string]: unknown } number string*

Defined in src/utils.ts:13

Transforme une string dans le type renseigné

Parameters:

Name	Type	Description
`value`	string \| null	Chaîne à transformer
`type?`	unknown	Type dans lequel transformer la chaîne : Boolean, Number, Object, Array, …

Returns: *{ [name: string]: unknown }

number

string*

generateId

▸ generateId(): string

Defined in src/utils.ts:62

Retourne un id de type string

Returns: string

getFile

▸ getFile(url: string): *Promise<Record<string, unknown> string>*

Defined in src/utils.ts:103

Retourne le texte contenu dans le fichier spécifié de façon asynchrone

Parameters:

Name	Type	Description
`url`	string	Url du fichier à traiter

Returns: *Promise<Record<string, unknown>

string>*

getWindowSize

▸ getWindowSize(): object

Defined in src/utils.ts:83

Retourne la taille et la position de la fenêtre web courante

Returns: object

Retourne { width: number, height: number, top: number, left: number }

load

▸ load<T>(key: string): T

Defined in src/utils.ts:132

Retourne les données spécifiées dans la clé en local storage

Type parameters:

▪ T

Le type des données à retourner

Parameters:

Name	Type	Description
`key`	string	La clé à utiliser pour charger les données

Returns: T

Retourne les données

save

▸ save<T>(key: string, datas: T): void

Defined in src/utils.ts:120

Enregistre les données dans la clé spécifiée en local storage

Type parameters:

▪ T

Le type des données à sauvegarder

Parameters:

Name	Type	Description
`key`	string	La clé à utiliser pour sauvegarder les données
`datas`	T	Les données à sauvegarder

Returns: void

toString

▸ toString(value: unknown, type?: unknown): *string { [name: string]: unknown }*

Defined in src/utils.ts:33

Transforme une valeur du type renseigné en string

Parameters:

Name	Type	Description
`value`	unknown	La valeur à transformer en string
`type?`	unknown	Type de la valeur à transformer : Boolean, Number, Object, Array, …

Returns: *string

{ [name: string]: unknown }*

slugify

▸ slugify(str: string, options?: { isPath?: boolean, replacementChar?: string }): string

Defined in src/utils.ts:185

Retourne une string utilisable dans une url (contenant toujours les / et les :)

Parameters:

Name	Type	Description
`str`	string	La chaîne à traiter
`options?`	{ isPath?: boolean, replacementChar?: string }	`isPath` Ne tramsforme pas les / et les :, utile pour créer une route ou un path, `replacementChar` Le caractère de remplacement utilisé, _ par défaut

Returns: string

generateIdFromString

▸ generateIdFromString(str: string): number

Defined in src/utils.ts:209

Retourne un id de type number en fonction de la chaîne de caratères passée en paramètre

Parameters:

Name	Type	Description
`str`	string	La chaîne de caractères à utitliser

Returns: string