Skip to content

Improved definitions for awesome-notifications #69938

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
typescript-bot merged 2 commits into from
Jul 10, 2024
Merged

Improved definitions for awesome-notifications #69938

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1c1e0a3
feat: Improved definitions
seebeen Jun 28, 2024
31610b2
fix: Optional parameter
seebeen Jul 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 41 additions & 14 deletions types/awesome-notifications/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

declare namespace AWN {
type AwnPosition = "bottom-right" | "bottom-left" | "top-left" | "top-right";

type AwnPopupType = "modal" | "confirm";
type AwnToastType = "global" | "tip" | "info" | "success" | "warning" | "alert";
type AwnAsyncType = "async" | "async-block";
type AwnConfirmType = "confirm" | "confirmOk" | "confirmCancel";
Expand Down Expand Up @@ -85,12 +85,27 @@ declare namespace AWN {
}

class Elem {
beforeInsert(): void;
afterInsert(): void;
insert(): Elem;
replace(el: Elem): Elem;
beforeDelete(el?: Elem): Promise<number>;
delete(el?: Elem): Promise<void> | null;
afterDelete(): void;
getElement<T extends HTMLDivElement>(el?: Elem): T;
addEvent<K extends keyof HTMLElementEventMap>(
name: K,
func: (this: HTMLDivElement, ev: HTMLElementEventMap[K]) => any,
): void;
toggleClass(classname: string): void;
updateType(type: AwnToastType | AwnPopupType): void;
}

class Toast extends Elem {
el: HTMLDivElement;

parent: HTMLDivElement;

setInnerHtml(html: string): void;

/**
Expand All @@ -100,6 +115,17 @@ declare namespace AWN {
* @default this.el
*/
isDeleted(el?: Elem): boolean;

get progressBar(): string;
get label(): string;
}

class Popup extends Elem {
setInnerHtml(html: string): void;
keyupListener(e: KeyboardEvent): void;

get okBtn(): HTMLButtonElement;
get cancelBtn(): HTMLButtonElement;
}
}

Expand All @@ -115,41 +141,41 @@ declare class AWN<E = Error> {
* Shows new tip toast
* @param message Defines message of the toast. Can be any valid HTML or text string. Will be set from defaults if omitted.
* @param options Instance of `AwnOptions`, which will override globals for this call
* @return A new HTMLDivElement instance
* @return A new Toast instance
*/
tip(message: string, options?: AWN.AwnOptions): HTMLDivElement;
tip(message: string, options?: AWN.AwnOptions): AWN.Toast;

/**
* Shows new info toast
* @param message Defines message of the toast. Can be any valid HTML or text string. Will be set from defaults if omitted.
* @param options Instance of `AwnOptions`, which will override globals for this call
* @return A new HTMLDivElement instance
* @return A new Toast instance
*/
info(message: string, options?: AWN.AwnOptions): HTMLDivElement;
info(message: string, options?: AWN.AwnOptions): AWN.Toast;

/**
* Shows new success toast
* @param message Defines message of the toast. Can be any valid HTML or text string. Will be set from defaults if omitted.
* @param options Instance of `AwnOptions`, which will override globals for this call
* @return A new HTMLDivElement instance
* @return A new Toast instance
*/
success(message: string, options?: AWN.AwnOptions): HTMLDivElement;
success(message: string, options?: AWN.AwnOptions): AWN.Toast;

/**
* Shows new warning toast
* @param message Defines message of the toast. Can be any valid HTML or text string. Will be set from defaults if omitted.
* @param options Instance of `AwnOptions`, which will override globals for this call
* @return A new HTMLDivElement instance
* @return A new Toast instance
*/
warning(message: string, options?: AWN.AwnOptions): HTMLDivElement;
warning(message: string, options?: AWN.AwnOptions): AWN.Toast;

/**
* Shows new alert toast
* @param message Defines message of the toast. Can be any valid HTML or text string. Will be set from defaults if omitted.
* @param options Instance of `AwnOptions`, which will override globals for this call
* @return A new HTMLDivElement instance
* @return A new Toast instance
*/
alert(message: string, options?: AWN.AwnOptions): HTMLDivElement;
alert(message: string, options?: AWN.AwnOptions): AWN.Toast;

/**
* Closes all visible toasts. Do nothing if there’re no visible toasts.
Expand Down Expand Up @@ -224,8 +250,9 @@ declare class AWN<E = Error> {
* @param message Defines message of the modal window. Can be any valid HTML or text string.
* @param className Defines modal window DOM element class name, it will be concatenated with default prefix ‘awn-popup-‘
* @param options Instance of `AwnOptions`, which will override globals for this call
* @return A new Popup instance
*/
modal(message: string, className?: string, options?: AWN.AwnOptions): void;
modal(message: string, className?: string, options?: AWN.AwnOptions): AWN.Popup;

/**
* Shows new confirmation window.
Expand All @@ -241,14 +268,14 @@ declare class AWN<E = Error> {
* @param onCancel Defines Function, which will be executed on click to ‘Cancel’ button.
* If false was passed, ‘Cancel’ button will be hidden.
* @param options Instance of `AwnOptions`, which will override globals for this call
* @return A new HTMLDivElement instance
* @return A new Popup instance
*/
confirm(
message: string,
onOk?: () => void,
onCancel?: (() => void) | false,
options?: AWN.AwnOptions,
): HTMLDivElement;
): AWN.Popup;
}

export = AWN;