Skip to content

Commit

Permalink
update readme examples
Browse files Browse the repository at this point in the history
  • Loading branch information
lucasferreiralimax committed Oct 15, 2024
1 parent ae734a8 commit 124d1b2
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 34 deletions.
34 changes: 17 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

An Angular library designed to create dynamic, customizable windows and window-based components for web applications. With a simple and intuitive API, UpWindow enables developers to easily integrate responsive windows, popups, and floating windows into their projects. It provides full control over window size, position, animations, and behavior, offering a flexible solution for creating engaging user interfaces.

<video width="100%" controls> <source src="https://raw.githubusercontent.com/criar-art/up-window-angular/master/public/modo-restrict-window.mp4" type="video/mp4"> Your browser does not support the video tag. </video>

## Install
```bash
npm install up-window-angular
Expand Down Expand Up @@ -40,7 +38,6 @@ export class WindowExampleComponent {
[isOpen]="isWindowOpenExample"
title="Window Title"
subtitle="This is the subtitle of the window."
size="medium"
>
Window Example content!
</up-window-angular>
Expand Down Expand Up @@ -94,45 +91,51 @@ export class WindowExampleComponent {
<up-window-angular restrictMode="true" ...></up-window-angular>
```

8. **`@Input() confirmText: string = 'Confirm';`**
- Example: Customize the confirm button text.
8. **`@Input() fullScreen: boolean = false;`**
- Example: Enable fullscreen mode for the window.
```html
<up-window-angular confirmText="Agree" ...></up-window-angular>
<up-window-angular [fullScreen]="true" ...></up-window-angular>
```

9. **`@Input() cancelText: string = 'Cancel';`**
- Example: Customize the cancel button text.
9. **`@Input() confirmText: string = 'Confirm';`**
- Example: Customize the confirm button text.
```html
<up-window-angular cancelText="Dismiss" ...></up-window-angular>
<up-window-angular confirmText="Agree" ...></up-window-angular>
```

10. **`@Input() confirmType: string = 'primary';`**
10. **`@Input() cancelText: string = 'Cancel';`**
- Example: Customize the cancel button text.
```html
<up-window-angular cancelText="Dismiss" ...></up-window-angular>
```

11. **`@Input() confirmType: string = 'primary';`**
- Example: Set the style of the confirm button.
```html
<up-window-angular confirmType="success" ...></up-window-angular>
```

11. **`@Input() cancelType: string = 'default';`**
12. **`@Input() cancelType: string = 'default';`**
- Example: Set the style of the cancel button.
```html
<up-window-angular cancelType="danger" ...></up-window-angular>
```

12. **`@Input() buttonAlignment: 'start' | 'end' | 'center' = 'end';`**
13. **`@Input() buttonAlignment: 'start' | 'end' | 'center' = 'end';`**
- Example: Align the buttons to the center.
```html
<up-window-angular buttonAlignment="center" ...></up-window-angular>
```

13. **`@Input() onConfirmClick: () => void = () => this.onConfirm();`**
14. **`@Input() onConfirmClick: () => void = () => this.onConfirm();`**
- Example: Custom confirm action.
```typescript
onConfirm() {
console.log('Confirmed!');
}
```

14. **`@Input() onCancelClick: () => void = () => this.onCancel();`**
15. **`@Input() onCancelClick: () => void = () => this.onCancel();`**
- Example: Custom cancel action.
```typescript
onCancel() {
Expand All @@ -157,6 +160,3 @@ export class WindowExampleComponent {
console.log('Cancel action triggered');
});
```

### Summary
The `up-window-angular` component offers a powerful way to create and manage modal windows in Angular applications, providing flexibility and ease of use through its customizable properties and events.
34 changes: 17 additions & 17 deletions projects/up-window-angular/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

An Angular library designed to create dynamic, customizable windows and window-based components for web applications. With a simple and intuitive API, UpWindow enables developers to easily integrate responsive windows, popups, and floating windows into their projects. It provides full control over window size, position, animations, and behavior, offering a flexible solution for creating engaging user interfaces.

<video width="100%" controls> <source src="https://raw.githubusercontent.com/criar-art/up-window-angular/master/public/modo-restrict-window.mp4" type="video/mp4"> Your browser does not support the video tag. </video>

## Install
```bash
npm install up-window-angular
Expand Down Expand Up @@ -40,7 +38,6 @@ export class WindowExampleComponent {
[isOpen]="isWindowOpenExample"
title="Window Title"
subtitle="This is the subtitle of the window."
size="medium"
>
Window Example content!
</up-window-angular>
Expand Down Expand Up @@ -94,45 +91,51 @@ export class WindowExampleComponent {
<up-window-angular restrictMode="true" ...></up-window-angular>
```

8. **`@Input() confirmText: string = 'Confirm';`**
- Example: Customize the confirm button text.
8. **`@Input() fullScreen: boolean = false;`**
- Example: Enable fullscreen mode for the window.
```html
<up-window-angular confirmText="Agree" ...></up-window-angular>
<up-window-angular [fullScreen]="true" ...></up-window-angular>
```

9. **`@Input() cancelText: string = 'Cancel';`**
- Example: Customize the cancel button text.
9. **`@Input() confirmText: string = 'Confirm';`**
- Example: Customize the confirm button text.
```html
<up-window-angular cancelText="Dismiss" ...></up-window-angular>
<up-window-angular confirmText="Agree" ...></up-window-angular>
```

10. **`@Input() confirmType: string = 'primary';`**
10. **`@Input() cancelText: string = 'Cancel';`**
- Example: Customize the cancel button text.
```html
<up-window-angular cancelText="Dismiss" ...></up-window-angular>
```

11. **`@Input() confirmType: string = 'primary';`**
- Example: Set the style of the confirm button.
```html
<up-window-angular confirmType="success" ...></up-window-angular>
```

11. **`@Input() cancelType: string = 'default';`**
12. **`@Input() cancelType: string = 'default';`**
- Example: Set the style of the cancel button.
```html
<up-window-angular cancelType="danger" ...></up-window-angular>
```

12. **`@Input() buttonAlignment: 'start' | 'end' | 'center' = 'end';`**
13. **`@Input() buttonAlignment: 'start' | 'end' | 'center' = 'end';`**
- Example: Align the buttons to the center.
```html
<up-window-angular buttonAlignment="center" ...></up-window-angular>
```

13. **`@Input() onConfirmClick: () => void = () => this.onConfirm();`**
14. **`@Input() onConfirmClick: () => void = () => this.onConfirm();`**
- Example: Custom confirm action.
```typescript
onConfirm() {
console.log('Confirmed!');
}
```

14. **`@Input() onCancelClick: () => void = () => this.onCancel();`**
15. **`@Input() onCancelClick: () => void = () => this.onCancel();`**
- Example: Custom cancel action.
```typescript
onCancel() {
Expand All @@ -157,6 +160,3 @@ export class WindowExampleComponent {
console.log('Cancel action triggered');
});
```

### Summary
The `up-window-angular` component offers a powerful way to create and manage modal windows in Angular applications, providing flexibility and ease of use through its customizable properties and events.

0 comments on commit 124d1b2

Please sign in to comment.