Class WebzDialog

Description

A dialog component that can be used to create a popup dialog

Export

WebzDialog

Example

const dialog = new WebzDialog("<h1>Hello World</h1>", "h1{color:red;}");

Hierarchy (view full)

WebzComponent
- WebzDialog

Index

Constructors

constructor

new WebzDialog(html?, css?): WebzDialog
Parameters
- Optional html: string = ""
  The html as a string to be used as the body of this component
- Optional css: string = ""
  The css as a string to be used as the style of this component
Returns WebzDialog
Description
Creates an instance of WebzDialog.

Memberof
WebzDialog

Example
```
const dlg = new WebzDialog("<h1>Hello World</h1>", "h1{color:red;}");
```
Overrides WebzComponent.constructor
- Defined in projects/boots/Webz/Webz-core/src/WebzDialog.ts:95

Properties

`Private` background

background: HTMLDivElement

`Private` closeEvent

closeEvent: Notifier<string> = ...

`Private` popup

popup: HTMLDivElement

`Static` `Private` popupButtons

popupButtons: HTMLButtonElement[] = []

Accessors

onResizeEvent

get onResizeEvent(): Notifier<SizeInfo>
Returns Notifier<SizeInfo>
Description
An event that fires when the window is resized

Memberof
WebzComponent

Example
```
this.onResizeEvent.subscribe((sizeInfo) => {
 console.log(sizeInfo.windowWidth);
 console.log(sizeInfo.windowHeight);
});
```
Inherited from WebzComponent.onResizeEvent
- Defined in projects/boots/Webz/Webz-core/src/WebzComponent.ts:68

Methods

addComponent

addComponent(component, id?, front?): void
Parameters
- component: WebzComponent
  The component to add
- id: string = "root"
  The id of the element to append the component to (optional)
- front: boolean = false
Returns void
void
Description
Add a component to the dom

Memberof
WebzComponent

Example
```
component.addComponent(childComponent);
  component.addComponent(childComponent, "myDiv");
```
Inherited from WebzComponent.addComponent
- Defined in projects/boots/Webz/Webz-core/src/WebzComponent.ts:123

addRouter

addRouter(routes, id?): void
Parameters
- routes: Route[]
- id: string = "root"
  The id of the element to append the router to (optional)
Returns void
the router
Description
Add a router to the component

Memberof
WebzComponent

Example
```
component.addRouter(router);
```
Inherited from WebzComponent.addRouter
- Defined in projects/boots/Webz/Webz-core/src/WebzComponent.ts:163

appendToDomElement

appendToDomElement(domElement): void
Parameters
- domElement: HTMLElement
Returns void
void
Description
Append the component to a dom element

Memberof
WebzComponent

Example
```
component.appendToDomElement(document.getElementById("myDiv"));
```
Inherited from WebzComponent.appendToDomElement
- Defined in projects/boots/Webz/Webz-core/src/WebzComponent.ts:191

click

click(elementId): void
Parameters
- elementId: string
  The id of the element to click
Returns void
void

Description
Click an element on this component
Inherited from WebzComponent.click
- Defined in projects/boots/Webz/Webz-core/src/WebzComponent.ts:267

focus

focus(elementId): void
Parameters
- elementId: string
  The id of the element to focus
Returns void
void

Description
Set focus to an element on this component
Inherited from WebzComponent.focus
- Defined in projects/boots/Webz/Webz-core/src/WebzComponent.ts:257

getValue

getValue(elementId): string
Parameters
- elementId: string
  The id of the element to get the value of
Returns string
string | undefined

Description
Get the value of an element on this component.

Throws
Error when element does not have a value property or does not exist

Memberof
Inherited from WebzComponent.getValue
- Defined in projects/boots/Webz/Webz-core/src/WebzComponent.ts:279

getWindowSize

getWindowSize(): SizeInfo
Returns SizeInfo
The size of the window
Description
Get the size of the window

Memberof
WebzComponent

Example
```
const sizeInfo: SizeInfo = myComponent.getWindowSize();
```
Inherited from WebzComponent.getWindowSize
- Defined in projects/boots/Webz/Webz-core/src/WebzComponent.ts:245

`Protected` removeComponent

removeComponent(component): WebzComponent
Parameters
- component: WebzComponent
Returns WebzComponent
WebzComponent
Description
Remove a component from the dom

Memberof
WebzComponent

Example
```
component.addComponent(childComponent);
component.removeComponent(childComponent);
```
Inherited from WebzComponent.removeComponent
- Defined in projects/boots/Webz/Webz-core/src/WebzComponent.ts:180

show

show(show?): void
Parameters
- Optional show: boolean = true
  Show or hide the dialog
Returns void
void
Description
Show or hide the dialog

Memberof
WebzDialog

Example
```
const dialog = new MyDialog();
dialog.show();
dialog.closeEvent.subscribe((value) => {
   console.log(value);
   dialog.show(false);
});
```
- Defined in projects/boots/Webz/Webz-core/src/WebzDialog.ts:127

`Static` ajax

ajax<T>(url, method, headers?, data?): Notifier<T>
Type Parameters
- T = any
Parameters
- url: string
  The URL to make the AJAX call to
- method: HttpMethod
  The HTTP method to use (GET or POST)
- headers: any[] = []
  The headers to send with the request (optional)
- Optional data: any
  The data to send in the request body (optional)
Returns Notifier<T>
A promise that resolves with the response data
Description
Makes an AJAX call

Memberof
WebzComponent

Static
Example
```
myComponent.ajax("https://some.api.url.com/posts", HttpMethod.GET)
 .subscribe((data) => {
  console.log(data);
}, (error) => {
  console.error(error);
});
```
Inherited from WebzComponent.ajax
- Defined in projects/boots/Webz/Webz-core/src/WebzComponent.ts:211

`Static` clickPopupButton

clickPopupButton(buttonNumber): void
Parameters
- buttonNumber: number
Returns void
- Defined in projects/boots/Webz/Webz-core/src/WebzDialog.ts:135

`Static` popup

popup(attachTo, message, title?, buttons?, btnClass?): Notifier<string>
Parameters
- attachTo: WebzComponent
  The component to attach the dialog to
- message: string
  The message to display
- Optional title: string = "Alert"
  The title of the dialog
- Optional buttons: string[] = ...
  The buttons to display
- Optional btnClass: string = ""
  The class to apply to the buttons
Returns Notifier<string>
The event subject that is triggered when the dialog is closed
Description
Show a popup dialog

Static
Memberof
WebzDialog

Example
```
WebzDialog.popup("Hello World", "Alert", ["Ok","Cancel"], "btn btn-primary")
   .subscribe((value:string) => {
      if (value === "Ok") console.log("Ok was clicked");
      else console.log("Cancel was clicked");
  });
```
- Defined in projects/boots/Webz/Webz-core/src/WebzDialog.ts:163

Class WebzDialog

Description

Export

Example

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns WebzDialog

Description

Memberof

Example

Properties

Private background

Private closeEvent

Private popup

Static Private popupButtons

Accessors

onResizeEvent

Returns Notifier<SizeInfo>

Description

Memberof

Example

Methods

addComponent

Parameters

Returns void

Description

Memberof

Example

addRouter

Parameters

Returns void

Description

Memberof

Example

appendToDomElement

Parameters

Returns void

Description

Memberof

Example

click

Parameters

Returns void

Description

focus

Parameters

Returns void

Description

getValue

Parameters

Returns string

Description

Throws

Memberof

getWindowSize

Returns SizeInfo

Description

Memberof

Example

Protected removeComponent

Parameters

Returns WebzComponent

Description

Memberof

Example

show

Parameters

Returns void

Description

Memberof

Example

Static ajax

Type Parameters

`Private` background

`Private` closeEvent

`Private` popup

`Static` `Private` popupButtons

`Protected` removeComponent

`Static` ajax

`Static` clickPopupButton

`Static` popup