ngx-mat-tui-calendar 12.0.1 → 12.0.2

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.
Files changed (2) hide show
  1. package/README.md +58 -41
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -20,13 +20,13 @@ This project is an [Angular](https://angular.io/), [Material Design](https://mat
20
20
  * Responsive to mobile devices
21
21
  * Dark mode in progress...
22
22
 
23
- This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 12.2.3.
24
-
25
- Curently using Angular ^12.2, which requires node ^v14.15 (npm ^v6.14).
26
-
27
-
23
+ This repo contains two projects:
24
+ 1. the npm library called `ngx-mat-tui-calendar`, located in `projects/ngx-mat-tui-calendar`
25
+ 2. the demo app, located in `src`
28
26
 
27
+ The top-level `angular.json` and `package.json` files are used for building both projects.
29
28
 
29
+ This repo was generated with [Angular CLI](https://github.com/angular/angular-cli) version 12.2.3. Angular ^12.2 requires node ^v14.15 (npm ^v6.14).
30
30
 
31
31
 
32
32
  # UI
@@ -53,32 +53,32 @@ npm i --save ngx-mat-tui-calendar
53
53
  Next import the module into your app's ```app.module.ts```:
54
54
  ```typescript
55
55
  import {NgxMatTuiCalendarModule} from 'ngx-mat-tui-calendar';
56
-
57
- @NgModule({
58
- imports: [NgxMatTuiCalendarModule]
59
- })
60
-
61
56
  ```
57
+ Then add `NgxMatTuiCalendarModule` to your list of NgModule imports, in ```app.module.ts```
62
58
 
63
59
  Insert the following HTML into one of your app's template files
64
60
  ```angular2html
65
61
  <mat-tui-calendar></mat-tui-calendar>
66
62
  ```
67
63
 
64
+ ## Quickstart Project
65
+ *TODO*
66
+
68
67
  ## Demo Project
68
+ *TODO*
69
69
 
70
- ## Stackblitz
70
+ ### Stackblitz
71
+ *TODO*
71
72
 
72
73
  # Documentation
73
74
 
74
75
  ## MatTuiCalendar
75
76
 
76
- Directive responsible for managing the timepicker popup and setting value to input
77
77
 
78
- Selector: `mat-tui-calendar`
78
+ Selector: `ngx-mat-tui-calendar`
79
79
 
80
80
  ```typescript
81
- <mat-tui-calendar #tuiCalendar
81
+ <ngx-mat-tui-calendar #tuiCalendar
82
82
  (userCreatedSchedule)="onUserCreatedSchedule($event)"
83
83
  (userUpdatedSchedule)="onUserUpdatedSchedule($event)"
84
84
  (userDeletedSchedule)="onUserDeletedSchedule($event)"
@@ -91,45 +91,62 @@ Selector: `mat-tui-calendar`
91
91
  | Name | Description |
92
92
  |------|-------------|
93
93
  | @Input()
94
- ngxMatTimepicker: NgxMatTimepickerComponent | The timepicker that this input is associated with. |
95
- | @Input()
96
- color: ThemePalette | The material palette to use. |
97
- | @Input()
98
- disabled: boolean | Weather the timepicker popup should be disabled. |
99
- | @Input()
100
- value: string | Set a default value and time for a timepicker. The format of the time is in 12 hours notation `11:00 PM` or in 24 hours notation `23:00`. A Date string won't work. |
101
- | @Input()
102
- format: number | `12` or `24` . 12h/24h view for hour selection clock . `12` (AM/PM) format by default. |
103
- | @Input()
104
- min: string or DateTime | Set min time for timepicker (`11:15 pm` ) |
105
- | @Input()
106
- max: string or DateTime | Set max time for timepicker (`11:15 pm` ) |
107
- | @Input()
108
- disableClick: boolean | Set `true` to disable opening timepicker by clicking on the input |
94
+ options: CalendarOptions | The options object for the calendar. |
95
+ | @Output()
96
+ userCreatedSchedule: EventEmitter<ISchedule> | Event emitter that emits when the user creates a new "schedule" (ie calendar task). |
97
+ | @Output()
98
+ userUpdatedSchedule: EventEmitter<ISchedule> | Event emitter that emits when the user updates a "schedule" (ie calendar task). |
99
+ | @Output()
100
+ userDeletedSchedule: EventEmitter<ISchedule> | Event emitter that emits when the user deletes a "schedule" (ie calendar task). |
109
101
 
110
102
 
111
103
  # Development
112
104
 
113
- ## Development server
105
+ ## library package for ngx-mat-tui-calendar
114
106
 
115
- Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
107
+ The code that makes up the npm package is located in folder ```projects/ngx-mat-tui-calendar```.
116
108
 
117
- ## Code scaffolding
109
+ After making changes, increment the version in ```projects/ngx-mat-tui-calendar/package.json```. We use the convention that the major version number corresponds to the major version of Angular used. The minor and patch versions are specific to this package.
110
+
111
+ The top-level `angular.json` file defines the build process for the library. The top-level `package.json` must include all the peer dependencies in `projects/ngx-mat-tui-calendar/package.json`.
112
+
113
+ ### API
114
+
115
+ The API is defined in ```projects/ngx-mat-tui-calendar/src/public-api.ts```.
116
+
117
+ ### Build
118
+
119
+ Run `ng build` to build the project. The build artifacts will be stored in the `dist/ngx-mat-tui-calendar` directory.
120
+
121
+ ### README
118
122
 
119
- Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.
123
+ The main README file (`README.md`) and the package README file (`projects/ngx-mat-tui-calendar/README.md`) must be manually kept in sync: if you change one, then copy the change to the other.
120
124
 
121
- ## Build
125
+ ### Publish package to https://npmjs.com/
122
126
 
123
- Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory.
127
+ Change directories to the `dist/ngx-mat-tui-calendar` directory and run the following:
128
+ ```bash
129
+ npm login
130
+ npm publish
131
+ ```
132
+
133
+ ### publish source to github
124
134
 
125
- ## Running unit tests
135
+ Commit your changes and push to github.com. Then create a tab and release on github that matches the npm version number.
126
136
 
127
- Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
128
137
 
129
- ## Running end-to-end tests
138
+ ## Demo App
139
+ ### Development server
140
+
141
+ The demo app is defined by the top-level `package.json` file, the top-level `angular.json` file and the contents of the `src` folder.
142
+
143
+ Run `ng serve demo` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
144
+
145
+ However, if you change the library files, in directory `projects/ngx-mat-tui-calendar`, you need to
146
+ 1. Rebuild the library using `ng build`
147
+ 2. Kill the dev server by typing `Ctrl-C` in the terminal where you are running `ng serve demo`
148
+ 3. Run `ng serve demo` to restart the dev server
130
149
 
131
- Run `ng e2e` to execute the end-to-end tests via a platform of your choice. To use this command, you need to first add a package that implements end-to-end testing capabilities.
150
+ *Step 2 is usually necessary! You will get spurious errors without killing and restarting the server.*
132
151
 
133
- ## Further help
134
152
 
135
- To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ngx-mat-tui-calendar",
3
- "version": "12.0.1",
3
+ "version": "12.0.2",
4
4
  "author": "ron schmitt",
5
5
  "license": "MIT",
6
6
  "description": "Angular Material Design wrapper, supporting theming, for the Toast UI Calendar, suitable for web-based scheduling, events, appointments, and day planner applications.",