typings.d.ts 1.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. /**
  2. * Use of this source code is governed by an MIT-style license that can be
  3. * found in the LICENSE file at https://github.com/NG-ZORRO/ng-zorro-antd/blob/master/LICENSE
  4. */
  5. import { Observable } from 'rxjs';
  6. import { NzTreeNode } from 'ng-zorro-antd/core/tree';
  7. import { NzSafeAny, NzSizeLDSType } from 'ng-zorro-antd/core/types';
  8. import { NzCascaderTreeService } from './cascader-tree.service';
  9. export type NzCascaderExpandTrigger = 'click' | 'hover';
  10. export type NzCascaderTriggerType = 'click' | 'hover';
  11. export type NzCascaderSize = NzSizeLDSType;
  12. export type NzCascaderFilter = (searchValue: string, path: NzCascaderOption[]) => boolean;
  13. export type NzCascaderSorter = (a: NzCascaderOption[], b: NzCascaderOption[], inputValue: string) => number;
  14. export type NzCascaderPlacement = 'bottomLeft' | 'bottomRight' | 'topLeft' | 'topRight';
  15. export interface NzCascaderOption {
  16. value?: NzSafeAny;
  17. label?: string;
  18. title?: string;
  19. disabled?: boolean;
  20. loading?: boolean;
  21. isLeaf?: boolean;
  22. children?: NzCascaderOption[];
  23. disableCheckbox?: boolean;
  24. [key: string]: NzSafeAny;
  25. }
  26. export interface NzShowSearchOptions {
  27. filter?: NzCascaderFilter;
  28. sorter?: NzCascaderSorter;
  29. }
  30. export declare function isShowSearchObject(options: NzShowSearchOptions | boolean): options is NzShowSearchOptions;
  31. /**
  32. * To avoid circular dependency, provide an interface of `NzCascaderComponent`
  33. * for `NzCascaderService`.
  34. */
  35. export interface NzCascaderComponentAsSource {
  36. inputValue: string;
  37. nzShowSearch: NzShowSearchOptions | boolean;
  38. nzLabelProperty: string;
  39. nzValueProperty: string;
  40. nzChangeOnSelect: boolean;
  41. selectedNodes: NzTreeNode[];
  42. get treeService(): NzCascaderTreeService;
  43. coerceTreeNodes(value: NzSafeAny[]): NzTreeNode[];
  44. updateSelectedNodes(): void;
  45. nzChangeOn?(option: NzCascaderOption, level: number): boolean;
  46. nzLoadData?(node: NzCascaderOption, index: number): PromiseLike<NzSafeAny> | Observable<NzSafeAny>;
  47. }