cat-documents-ng 0.2.87 → 0.2.89
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/README.md +99 -0
- package/Shared/constant/SHARED.d.ts +13 -0
- package/fesm2022/cat-documents-ng.mjs +266 -52
- package/fesm2022/cat-documents-ng.mjs.map +1 -1
- package/lib/document/components/folder-container/folder-container.component.d.ts +12 -0
- package/lib/document/components/sidebar/sidebar.component.d.ts +53 -6
- package/lib/document/document.module.d.ts +2 -1
- package/lib/document/services/document-upload.service.d.ts +9 -0
- package/lib/document/state/document.query.d.ts +0 -5
- package/package.json +1 -1
- package/src/lib/styles.scss +23 -0
package/README.md
CHANGED
|
@@ -320,3 +320,102 @@ folderBlocks: Data sourced from FOLDERPANEL for folder blocks.
|
|
|
320
320
|
|
|
321
321
|
## Additional Resources
|
|
322
322
|
For more information on using the Angular CLI, including detailed command references, visit the [Angular CLI Overview and Command Reference](https://angular.dev/tools/cli) page.
|
|
323
|
+
|
|
324
|
+
## Troubleshooting
|
|
325
|
+
|
|
326
|
+
### Confirmation Dialog Not Visible
|
|
327
|
+
|
|
328
|
+
If you experience issues where confirmation dialogs are not visible when the library is installed in your project, this is likely due to z-index conflicts. Here are the solutions:
|
|
329
|
+
|
|
330
|
+
#### Solution 1: Import Global Styles
|
|
331
|
+
|
|
332
|
+
Import the library's global styles in your main `styles.scss` or `angular.json`:
|
|
333
|
+
|
|
334
|
+
```scss
|
|
335
|
+
// In your styles.scss
|
|
336
|
+
@import '~cat-document-lib/lib/styles.scss';
|
|
337
|
+
```
|
|
338
|
+
|
|
339
|
+
#### Solution 2: Configure Z-Index in angular.json
|
|
340
|
+
|
|
341
|
+
Add the library's styles to your `angular.json` file:
|
|
342
|
+
|
|
343
|
+
```json
|
|
344
|
+
{
|
|
345
|
+
"projects": {
|
|
346
|
+
"your-project": {
|
|
347
|
+
"architect": {
|
|
348
|
+
"build": {
|
|
349
|
+
"options": {
|
|
350
|
+
"styles": [
|
|
351
|
+
"src/styles.scss",
|
|
352
|
+
"node_modules/cat-document-lib/lib/styles.scss"
|
|
353
|
+
]
|
|
354
|
+
}
|
|
355
|
+
}
|
|
356
|
+
}
|
|
357
|
+
}
|
|
358
|
+
}
|
|
359
|
+
}
|
|
360
|
+
```
|
|
361
|
+
|
|
362
|
+
#### Solution 3: Override Z-Index in Host Project
|
|
363
|
+
|
|
364
|
+
If the above solutions don't work, you can override the z-index values in your host project's CSS:
|
|
365
|
+
|
|
366
|
+
```scss
|
|
367
|
+
/* Ensure confirmation dialogs are visible */
|
|
368
|
+
.p-confirm-dialog {
|
|
369
|
+
z-index: 10001 !important;
|
|
370
|
+
}
|
|
371
|
+
|
|
372
|
+
.p-dialog-mask {
|
|
373
|
+
z-index: 10000 !important;
|
|
374
|
+
}
|
|
375
|
+
|
|
376
|
+
.p-sidebar {
|
|
377
|
+
z-index: 10000 !important;
|
|
378
|
+
}
|
|
379
|
+
```
|
|
380
|
+
|
|
381
|
+
#### Solution 4: Use Higher Base Z-Index
|
|
382
|
+
|
|
383
|
+
When using the sidebar component, you can specify a higher base z-index:
|
|
384
|
+
|
|
385
|
+
```html
|
|
386
|
+
<lib-sidebar
|
|
387
|
+
[baseZIndex]="20000"
|
|
388
|
+
[autoZIndex]="false">
|
|
389
|
+
<!-- content -->
|
|
390
|
+
</lib-sidebar>
|
|
391
|
+
```
|
|
392
|
+
|
|
393
|
+
### Common Issues
|
|
394
|
+
|
|
395
|
+
1. **Dialog appears behind other elements**: This is usually a z-index issue. Use Solution 1 or 2 above.
|
|
396
|
+
2. **Sidebar not visible**: Check if the `visible` property is properly bound and the component is not hidden by CSS.
|
|
397
|
+
3. **Confirmation dialog not showing**: Ensure PrimeNG's ConfirmationService is properly configured in your app.
|
|
398
|
+
|
|
399
|
+
## API Reference
|
|
400
|
+
|
|
401
|
+
### SidebarComponent
|
|
402
|
+
|
|
403
|
+
The main sidebar component with the following inputs:
|
|
404
|
+
|
|
405
|
+
- `visible`: Boolean to control sidebar visibility
|
|
406
|
+
- `position`: 'left' | 'right' - Sidebar position
|
|
407
|
+
- `width`: String for sidebar width
|
|
408
|
+
- `baseZIndex`: Number for z-index (default: 10000)
|
|
409
|
+
- `autoZIndex`: Boolean to auto-manage z-index (default: false)
|
|
410
|
+
|
|
411
|
+
## Contributing
|
|
412
|
+
|
|
413
|
+
1. Fork the repository
|
|
414
|
+
2. Create a feature branch
|
|
415
|
+
3. Make your changes
|
|
416
|
+
4. Add tests
|
|
417
|
+
5. Submit a pull request
|
|
418
|
+
|
|
419
|
+
## License
|
|
420
|
+
|
|
421
|
+
This project is licensed under the MIT License.
|
|
@@ -58,6 +58,10 @@ export declare class SHARED {
|
|
|
58
58
|
* Represents an empty string.
|
|
59
59
|
*/
|
|
60
60
|
static EMPTY: string;
|
|
61
|
+
/**
|
|
62
|
+
* Represents an empty string.
|
|
63
|
+
*/
|
|
64
|
+
static STRING: string;
|
|
61
65
|
/**
|
|
62
66
|
* Represents an true.
|
|
63
67
|
* @static
|
|
@@ -228,7 +232,16 @@ export declare class SHARED {
|
|
|
228
232
|
static UPLOAD_FAILED: string;
|
|
229
233
|
static USER_LIST: string;
|
|
230
234
|
static CATEGORIES: string;
|
|
235
|
+
static UNSAVED_CHANGES_MESSAGE: string;
|
|
236
|
+
static UNSAVED_CHANGES_HEADER: string;
|
|
231
237
|
static DOCUMENT_DELETED_SUCCESSFULLY: string;
|
|
238
|
+
static UNSAVED_CHANGES_ICON: string;
|
|
239
|
+
static REMOVE: string;
|
|
240
|
+
static CANCEL: string;
|
|
241
|
+
static ACCEPT_ICON: string;
|
|
242
|
+
static REJECT_ICON: string;
|
|
243
|
+
static ACCEPT_BUTTON_STYLE_CLASS: string;
|
|
244
|
+
static REJECT_BUTTON_STYLE_CLASS: string;
|
|
232
245
|
static Menu: {
|
|
233
246
|
label: string;
|
|
234
247
|
items: ({
|