angular-material-wrap 0.1.0-beta.0 → 0.1.0-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 Daniel Hokanson
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -41,28 +41,80 @@ npm install @angular/animations @angular/cdk @angular/common @angular/core @angu
41
41
 
42
42
  ## Quick Start
43
43
 
44
- ### Import Components
44
+ ### 1. Configure Animations
45
+
46
+ Add Angular animations to your application bootstrap (`main.ts`):
47
+
48
+ ```typescript
49
+ import { bootstrapApplication } from '@angular/platform-browser';
50
+ import { provideAnimations } from '@angular/platform-browser/animations';
51
+ import { AppComponent } from './app/app.component';
52
+
53
+ bootstrapApplication(AppComponent, {
54
+ providers: [
55
+ provideAnimations(),
56
+ // ... other providers
57
+ ]
58
+ }).catch((err) => console.error(err));
59
+ ```
60
+
61
+ **For module-based apps**, add to your `app.module.ts`:
62
+
63
+ ```typescript
64
+ import { BrowserAnimationsModule } from '@angular/platform-browser/animations';
65
+
66
+ @NgModule({
67
+ imports: [BrowserAnimationsModule, /* ... */]
68
+ })
69
+ export class AppModule { }
70
+ ```
71
+
72
+ ### 2. Import Library Styles
73
+
74
+ Add the library styles to your global `styles.scss` file:
75
+
76
+ ```scss
77
+ /* Import Angular Material Wrap Library Styles */
78
+ @use 'angular-material-wrap/styles';
79
+
80
+ /* Your other styles */
81
+ body {
82
+ font-family: 'Roboto', sans-serif;
83
+ margin: 0;
84
+ }
85
+ ```
86
+
87
+ ### 3. Import and Use Components
88
+
89
+ All components are standalone and can be imported directly:
45
90
 
46
91
  ```typescript
47
92
  import { Component } from '@angular/core';
48
- import { AmwButtonComponent } from 'angular-material-wrap';
93
+ import { AmwButtonComponent, AmwInputComponent } from 'angular-material-wrap';
94
+ import { FormsModule } from '@angular/forms';
49
95
 
50
96
  @Component({
51
97
  selector: 'app-root',
52
98
  standalone: true,
53
- imports: [AmwButtonComponent],
99
+ imports: [AmwButtonComponent, AmwInputComponent, FormsModule],
54
100
  template: `
101
+ <amw-input
102
+ [config]="{ label: 'Username', placeholder: 'Enter username' }"
103
+ [(ngModel)]="username">
104
+ </amw-input>
105
+
55
106
  <amw-button
56
- label="Click me"
57
- type="raised"
58
- color="primary"
59
- (clicked)="handleClick()">
107
+ [config]="{ color: 'primary', variant: 'raised' }"
108
+ (click)="handleClick()">
109
+ Submit
60
110
  </amw-button>
61
111
  `
62
112
  })
63
113
  export class AppComponent {
114
+ username = '';
115
+
64
116
  handleClick() {
65
- console.log('Button clicked!');
117
+ console.log('Username:', this.username);
66
118
  }
67
119
  }
68
120
  ```
@@ -119,10 +171,14 @@ export class AppComponent implements OnInit {
119
171
 
120
172
  ## Documentation
121
173
 
122
- For complete documentation, examples, and API reference, visit:
174
+ Complete documentation is included in this package:
175
+ - **[Implementation Guide](./docs/IMPLEMENTATION-GUIDE.md)** - Complete step-by-step guide with examples
176
+ - **[Quick Start for AI](./docs/CLAUDE-QUICK-START.md)** - Concise guide for AI assistants
177
+ - **[API Reference](./docs/API-REFERENCE.md)** - Full API documentation
178
+
179
+ Additional resources:
123
180
  - [GitHub Repository](https://github.com/danielhokanson/angular-material-wrap)
124
- - [API Documentation](https://github.com/danielhokanson/angular-material-wrap/blob/main/docs/library-api.md)
125
- - [Development Guide](https://github.com/danielhokanson/angular-material-wrap/blob/main/docs/development-workflow.md)
181
+ - [Issues & Support](https://github.com/danielhokanson/angular-material-wrap/issues)
126
182
 
127
183
  ## Component Areas
128
184