Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@cetincakiroglu
cetincakiroglu committed Sep 22, 2023
1 parent 19a805f commit 1150aab
Show file tree
Hide file tree
Showing 8 changed files with 46 additions and 74 deletions.
7 changes: 1 addition & 6 deletions src/app/components/cascadeselect/cascadeselect.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -419,7 +419,7 @@ export class CascadeSelect implements OnInit, AfterContentInit {
*/
@Input() placeholder: string | undefined;
/**
* No description available.
* Selected value of the component.
* @group Props
*/
@Input() value: string | undefined | null;
Expand Down Expand Up @@ -463,11 +463,6 @@ export class CascadeSelect implements OnInit, AfterContentInit {
* @group Props
*/
@Input() disabled: boolean | undefined;
/**
* No description available.
* @group Props
*/
@Input() rounded: boolean | undefined;
/**
* When enabled, a clear icon is displayed to clear the value.
* @group Props
Expand Down
10 changes: 0 additions & 10 deletions src/app/components/dropdown/dropdown.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -378,11 +378,6 @@ export class Dropdown implements OnInit, AfterViewInit, AfterContentInit, AfterV
* @group Props
*/
@Input() inputId: string | undefined;
/**
* No description available.
* @group Props
*/
@Input() selectId: string | undefined;
/**
* A property to uniquely identify a value in options.
* @group Props
Expand Down Expand Up @@ -533,11 +528,6 @@ export class Dropdown implements OnInit, AfterViewInit, AfterContentInit, AfterV
* @group Props
*/
@Input() autofocusFilter: boolean = true;
/**
* No description available.
* @group Props
*/
@Input() overlayDirection: string = 'end';
/**
* When present, it specifies that the component should be disabled.
* @group Props
Expand Down
6 changes: 1 addition & 5 deletions src/app/components/inputnumber/inputnumber.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@ export class InputNumber implements OnInit, AfterContentInit, OnChanges, Control
*/
@Input() name: string | undefined;
/**
* No description available.
* Indicates that whether the input field is required.
* @group Props
*/
@Input() required: boolean | undefined;
Expand Down Expand Up @@ -380,10 +380,6 @@ export class InputNumber implements OnInit, AfterContentInit, OnChanges, Control
* @group Props
*/
@Input() showClear: boolean = false;
/**
* No description available.
* @group Emits
*/
/**
* When present, it specifies that the element should be disabled.
* @group Props
Expand Down
6 changes: 3 additions & 3 deletions src/app/components/multiselect/multiselect.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -581,12 +581,12 @@ export class MultiSelect implements OnInit, AfterViewInit, AfterContentInit, Aft
*/
@Input() autofocusFilter: boolean = true;
/**
* No description available.
* Defines how the selected items are displayed.
* @group Props
*/
@Input() display: string = 'comma';
@Input() display: string | 'comma' | 'chip' = 'comma';
/**
* No description available.
* Defines the autocomplete is active.
* @group Props
*/
@Input() autocomplete: string = 'on';
Expand Down
2 changes: 1 addition & 1 deletion src/app/components/radiobutton/radiobutton.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ export class RadioButton implements ControlValueAccessor, OnInit, OnDestroy {
*/
@Input() value: any;
/**
* No description available.
* The name of the form control.
* @group Props
*/
@Input() formControlName: string | undefined;
Expand Down
10 changes: 5 additions & 5 deletions src/app/components/table/table.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -697,11 +697,6 @@ export class Table implements OnInit, AfterViewInit, AfterContentInit, Blockable
* @group Props
*/
@Input() paginatorLocale: string | undefined;
/**
* No description available.
* @param {TableSelectAllChangeEvent} event - custom all selection change event.
* @group Emits
*/
/**
* An array of objects to display.
* @group Props
Expand Down Expand Up @@ -803,6 +798,11 @@ export class Table implements OnInit, AfterViewInit, AfterContentInit, Blockable
set selectAll(val: boolean | null) {
this._selection = val;
}
/**
* Emits when the all of the items selected or unselected.
* @param {TableSelectAllChangeEvent} event - custom all selection change event.
* @group Emits
*/
@Output() selectAllChange: EventEmitter<TableSelectAllChangeEvent> = new EventEmitter<TableSelectAllChangeEvent>();
/**
* Callback to invoke on selection changed.
Expand Down
2 changes: 1 addition & 1 deletion src/app/components/tree/tree.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -851,7 +851,7 @@ export class Tree implements OnInit, AfterContentInit, OnChanges, OnDestroy, Blo
*/
@Input() filterPlaceholder: string | undefined;
/**
* No description available.
* Values after the tree nodes are filtered.
* @group Props
*/
@Input() filteredNodes: TreeNode<any>[] | undefined | null;
Expand Down
77 changes: 34 additions & 43 deletions src/app/showcase/doc/apidoc/index.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5980,7 +5980,7 @@
"optional": false,
"readonly": false,
"type": "string",
"description": "No description available."
"description": "Selected value of the component."
},
{
"name": "dataKey",
Expand Down Expand Up @@ -6039,14 +6039,6 @@
"default": "false",
"description": "When present, it specifies that the component should be disabled."
},
{
"name": "rounded",
"optional": false,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "No description available."
},
{
"name": "showClear",
"optional": false,
Expand Down Expand Up @@ -9073,13 +9065,6 @@
"type": "string",
"description": "Identifier of the accessible input element."
},
{
"name": "selectId",
"optional": false,
"readonly": false,
"type": "string",
"description": "No description available."
},
{
"name": "dataKey",
"optional": false,
Expand Down Expand Up @@ -9305,14 +9290,6 @@
"default": "true",
"description": "Applies focus to the filter element when the overlay is shown."
},
{
"name": "overlayDirection",
"optional": false,
"readonly": false,
"type": "string",
"default": "end",
"description": "No description available."
},
{
"name": "disabled",
"optional": false,
Expand Down Expand Up @@ -9720,19 +9697,12 @@
}
},
"dynamicdialog-config": {
"components": {},
"interfaces": {
"description": "Defines the custom interfaces used by the module.",
"values": [
{
"name": "DynamicDialogConfig",
"description": "Dialogs can be created dynamically with any component as the content using a DialogService.",
"props": [
{
"name": "constructor",
"optional": false,
"readonly": false
},
"components": {
"DynamicDialogConfig": {
"description": "Dialogs can be created dynamically with any component as the content using a DialogService.",
"props": {
"description": "Defines the input properties of the component.",
"values": [
{
"name": "data",
"optional": true,
Expand Down Expand Up @@ -9780,6 +9750,7 @@
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Specifies if pressing escape key should hide the dialog."
},
{
Expand All @@ -9794,20 +9765,23 @@
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Whether to automatically manage layering."
},
{
"name": "dismissableMask",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Specifies if clicking the modal background should hide the dialog."
},
{
"name": "rtl",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Inline style of the component."
},
{
Expand Down Expand Up @@ -9843,20 +9817,23 @@
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Adds a close icon to the header to hide the dialog."
},
{
"name": "showHeader",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Whether to show the header or not."
},
{
"name": "modal",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Defines if background should be blocked when dialog is displayed."
},
{
Expand All @@ -9871,20 +9848,23 @@
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Enables resizing of the content."
},
{
"name": "draggable",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Enables dragging to change the position using header."
},
{
"name": "keepInViewport",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Keeps dialog in the viewport."
},
{
Expand All @@ -9906,6 +9886,7 @@
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Whether the dialog can be displayed full screen."
},
{
Expand Down Expand Up @@ -9945,7 +9926,7 @@
}
]
}
]
}
}
},
"dynamicdialog-injector": {
Expand Down Expand Up @@ -12335,7 +12316,7 @@
"readonly": false,
"type": "boolean",
"default": "false",
"description": "No description available."
"description": "Indicates that whether the input field is required."
},
{
"name": "autocomplete",
Expand Down Expand Up @@ -14330,15 +14311,15 @@
"readonly": false,
"type": "string",
"default": "comma",
"description": "No description available."
"description": "Defines how the selected items are displayed."
},
{
"name": "autocomplete",
"optional": false,
"readonly": false,
"type": "string",
"default": "on",
"description": "No description available."
"description": "Defines the autocomplete is active."
},
{
"name": "showClear",
Expand Down Expand Up @@ -17495,7 +17476,7 @@
"optional": false,
"readonly": false,
"type": "string",
"description": "No description available."
"description": "The name of the form control."
},
{
"name": "name",
Expand Down Expand Up @@ -20788,6 +20769,16 @@
],
"description": "Callback to invoke on context menu selection change."
},
{
"name": "selectAllChange",
"parameters": [
{
"name": "event",
"type": "TableSelectAllChangeEvent"
}
],
"description": "Emits when the all of the items selected or unselected."
},
{
"name": "selectionChange",
"parameters": [
Expand Down Expand Up @@ -23369,7 +23360,7 @@
"optional": false,
"readonly": false,
"type": "TreeNode<any>[]",
"description": "No description available."
"description": "Values after the tree nodes are filtered."
},
{
"name": "filterLocale",
Expand Down

0 comments on commit 1150aab

Please sign in to comment.