@progress/kendo-angular-sortable 19.1.2-develop.4 → 19.1.2-develop.6

package/sortable.component.d.ts

@@ -13,7 +13,10 @@ import * as i0 from "@angular/core";
 /**
  * Represents the [Kendo UI Sortable component for Angular]({% slug overview_sortable %}).
  *
- * <demo metaUrl="sortable/sortable-api/" height="430"></demo>
+ * @example
+ * ```html
+ * <kendo-sortable [data]="['Item 1', 'Item 2', 'Item 3']"></kendo-sortable>
+ * ```
  */
 export declare class SortableComponent implements OnInit, OnDestroy, OnChanges, AfterViewInit, AfterViewChecked, AfterContentInit, SortableContainer {
     private ngZone;
@@ -26,7 +29,7 @@ export declare class SortableComponent implements OnInit, OnDestroy, OnChanges,
      */
     tabIndex: number;
     /**
-     * Configures how the Sortable component will track changes in its items collection.
+     * Configures how the Sortable component tracks changes in its items collection.
      */
     trackBy: TrackByFunction<any>;
     /**
@@ -35,61 +38,33 @@ export declare class SortableComponent implements OnInit, OnDestroy, OnChanges,
     set data(data: Array<any>);
     get data(): Array<any>;
     /**
-     * Enables or disables the [keyboard navigation]({% slug keyboard_navigation_sortable %}).
+     * Sets a boolean value that determines whether the Sortable items are navigable using the keyboard. [See example]({% slug keyboard_navigation_sortable %}).
      * @default true
      */
     navigable: boolean;
     /**
-     * Enables or disables the built-in animations.
+     * Enables or disables built-in animations.
      * @default false
      */
     animation: boolean;
     /**
-     * Sets an array of integers, which represent the indexes of the disabled items from the data array
-     * ([see example](slug:items_sortable#toc-disabling-items)).
+     * Sets an array of integers that represent the indexes of the disabled items from the data array. [See example](slug:items_sortable#toc-disabling-items).
      */
     disabledIndexes: number[];
     /**
      * Sets a string that represents the name of the zone to which the Sortable belongs
      * ([see example](slug:items_sortable#toc-transferring-of-items)). Items can be transferred
-     * between Sortables which belong to the same zone.
+     * between Sortables in the same zone.
      */
     zone: string;
     /**
      * Defines the zones from which items can be transferred onto the current Sortable component
      * ([see example](slug:items_sortable#toc-transferring-of-items)). If the `acceptZones` property
-     * of the target Sortable is set, allows you to transfer items between Sortables which belong
-     * to different zones.
+     * of the target Sortable is set, you can transfer items between Sortables in different zones.
      */
     acceptZones: string[];
     /**
-     * Represents the CSS styles which are applied to each Sortable item.
-     *
-     * @example
-     * ```ts
-     * import { Component } from '@angular/core';
-     * import { SortableModule } from '@progress/kendo-angular-sortable';
-     *
-     * _@Component({
-     *  selector: 'my-app',
-     *  template: `
-     *   <kendo-sortable
-     *      [data]="['1','2','3','4','5','6','7']"
-     *      [itemStyle] ="{
-     *          'display': 'inline-block',
-     *          'background-color': '#51A0ED',
-     *          'height':'50px',
-     *          'width':'50px',
-     *          'margin':'3px',
-     *          'cursor':'move'
-     *          }"
-     *      >
-     *   </kendo-sortable>
-     *    `
-     * })
-     * export class AppComponent {
-     * }
-     * ```
+     * Represents the CSS styles applied to each Sortable item.
      */
     itemStyle: {
         [key: string]: string;
@@ -130,23 +105,6 @@ export declare class SortableComponent implements OnInit, OnDestroy, OnChanges,
     disabledItemClass: string | string[] | Set<string>;
     /**
      * Sets the text message that will be displayed when the Sortable has no items.
-     *
-     * @example
-     * ```ts
-     * import { Component } from '@angular/core';
-     * import { SortableModule } from '@progress/kendo-angular-sortable';
-     *
-     * _@Component({
-     *  selector: 'my-app',
-     *  template: `
-     *    <kendo-sortable [data]="[]"
-     *      [emptyText]="'No items - custom message and styles'"
-     *      [emptyItemStyle] = "{'height': '40px', 'width':'400px', 'border': '2px dashed black'}" >
-     *    </kendo-sortable>
-     *    `
-     * })
-     * export class AppComponent { }
-     * ```
      */
     emptyText: string;
     /**
@@ -365,12 +323,12 @@ export declare class SortableComponent implements OnInit, OnDestroy, OnChanges,
      */
     removeDataItem(index: number): void;
     /**
-     * Sets a Boolean value that indicates whether the item will be hidden or not.
+     * Sets a boolean value that indicates whether the item will be hidden or not.
      * @hidden
      */
     hideItem(index: number, hidden?: boolean): void;
     /**
-     * Gets or sets a Boolean value that indicates whether the currently dragged item will be hidden.
+     * Gets or sets a boolean value that indicates whether the currently dragged item will be hidden.
      *
      * If the currently dragged item is hidden, returns `true`.
      * If the currently dragged item is visible, returns `false`.
@@ -379,7 +337,7 @@ export declare class SortableComponent implements OnInit, OnDestroy, OnChanges,
     set hideActiveItem(value: boolean);
     /**
      * Clears the active item.
-     * An active item is the item which becomes focused when the user navigates with the keyboard.
+     * An active item is the one that is currently focused when the user navigates with the keyboard.
      */
     clearActiveItem(): void;
     /**
@@ -388,13 +346,13 @@ export declare class SortableComponent implements OnInit, OnDestroy, OnChanges,
      */
     getActiveItem(): any;
     /**
-     * Adds a new data item to a particular index.
+     * Inserts a new data item at a particular index in the Sortable component.
      * @param dataItem - The data item.
      * @param index - The index at which the data item is inserted.
      */
     addDataItem(dataItem: any, index: number): void;
     /**
-     * Moves data item to a particular index.
+     * Moves a data item from one index to another in the Sortable component.
      * @param fromIndex - The data item's index.
      * @param toIndex - The index which the data item should be moved to. Item currently sitting at that index is pushed back one position.
      */

package/sortable.module.d.ts

@@ -8,33 +8,21 @@ import * as i2 from "./draggable.directive";
 import * as i3 from "./item-template.directive";
 import * as i4 from "./binding.directive";
 /**
- *
- * Represents the [`NgModule`](link:site.data.urls.angular['ngmoduleapi'])
- * definition for the Sortable component.
+ * Represents the [`NgModule`](link:site.data.urls.angular['ngmoduleapi']) definition for the Sortable component.
  *
  * @example
- *
- * ```ts-no-run
+ * ```typescript
  * import { NgModule } from '@angular/core';
  * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
- *
- * // Import the Sortable module
  * import { SortableModule } from '@progress/kendo-angular-sortable';
- *
- * // Import the app component
  * import { AppComponent } from './app.component';
  *
- * // Define the app module
- * _@NgModule({
+ * @NgModule({
  *     declarations: [AppComponent],
  *     imports:      [BrowserModule, SortableModule],
  *     bootstrap:    [AppComponent]
  * })
  * export class AppModule {}
- *
- * // Compile and launch the module
- * platformBrowserDynamic().bootstrapModule(AppModule);
- *
  * ```
  */
 export declare class SortableModule {

package/sortable.service.d.ts

@@ -8,9 +8,8 @@ import { DraggableDirective } from './draggable.directive';
 import { Subject } from 'rxjs';
 import * as i0 from "@angular/core";
 /**
- * The service that provides the drag-and-drop functionality for
- * transferring items between Sortable components within the same page.
- *
+ * The `SortableService` is a service that manages the drag-and-drop functionality
+ * for transferring items between Sortable components.
  */
 export declare class SortableService implements OnDestroy {
     private ngZone;
@@ -78,7 +77,7 @@ export declare class SortableService implements OnDestroy {
      */
     ngOnDestroy(): void;
     /**
-     * Registers a `SortableComponent` with which the service operates.
+     * Registers a `SortableComponent` with the `SortableService` so that it can be managed by the service.
      *
      * @param sortableComponent - The `SortableComponent`.
      * @return - The unique key that the current `SortableComponent` gets when registered.
@@ -113,9 +112,7 @@ export declare class SortableService implements OnDestroy {
      * Represents a single contact point (finger or stylus)
      * on a touch-sensitive device (touchscreen or trackpad).
      *
-     * @return { component: SortableComponent, index: number } - An object
-     * where the component is the `SortableComponent` that owns the item
-     * and the index is the index of the touched item.
+     * @return { component: SortableComponent, index: number } - An object where the component is the `SortableComponent` that owns the item and the index is the index of the touched item.
      */
     getSortableComponentFromTouch(touch: any): {
         component: SortableComponent;

package/util.d.ts

@@ -19,7 +19,7 @@ export declare const matchesNodeAttr: (nodeAttr: string) => any;
  */
 export declare const closest: (node: any, predicate: any) => any;
 /**
- * Returns an object specifiying whether there is a DraggableDirective under the cursor.
+ * Returns an object specifying whether there is a `DraggableDirective` under the cursor.
  * @hidden
  */
 export declare const draggableFromPoint: Function;