zone-selector-component.mdx 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119
  1. ---
  2. title: "ZoneSelectorComponent"
  3. generated: true
  4. ---
  5. <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/components/zone-selector/zone-selector.component.ts" sourceLine="40" packageName="@vendure/admin-ui" />
  6. A form control for selecting zones.
  7. ```ts title="Signature"
  8. class ZoneSelectorComponent implements ControlValueAccessor {
  9. @Output() selectedValuesChange = new EventEmitter<Zone>();
  10. @Input() readonly = false;
  11. @Input() transformControlValueAccessorValue: (value: Zone | undefined) => any = value => value?.id;
  12. selectedId$ = new Subject<string>();
  13. onChangeFn: (val: any) => void;
  14. onTouchFn: () => void;
  15. disabled = false;
  16. value: string | Zone;
  17. zones$ = this.dataService
  18. .query(GetZoneSelectorListDocument, { options: { take: 999 } })
  19. .mapSingle(result => result.zones.items);
  20. constructor(dataService: DataService, changeDetectorRef: ChangeDetectorRef)
  21. onChange(selected: Zone) => ;
  22. registerOnChange(fn: any) => ;
  23. registerOnTouched(fn: any) => ;
  24. setDisabledState(isDisabled: boolean) => void;
  25. focus() => ;
  26. writeValue(obj: string | Zone | null) => void;
  27. }
  28. ```
  29. * Implements: ControlValueAccessor
  30. <div className="members-wrapper">
  31. ### selectedValuesChange
  32. <MemberInfo kind="property" type={``} />
  33. ### readonly
  34. <MemberInfo kind="property" type={``} />
  35. ### transformControlValueAccessorValue
  36. <MemberInfo kind="property" type={`(value: <a href='/reference/typescript-api/entities/zone#zone'>Zone</a> | undefined) => any`} />
  37. ### selectedId$
  38. <MemberInfo kind="property" type={``} />
  39. ### onChangeFn
  40. <MemberInfo kind="property" type={`(val: any) => void`} />
  41. ### onTouchFn
  42. <MemberInfo kind="property" type={`() => void`} />
  43. ### disabled
  44. <MemberInfo kind="property" type={``} />
  45. ### value
  46. <MemberInfo kind="property" type={`string | <a href='/reference/typescript-api/entities/zone#zone'>Zone</a>`} />
  47. ### zones$
  48. <MemberInfo kind="property" type={``} />
  49. ### constructor
  50. <MemberInfo kind="method" type={`(dataService: <a href='/reference/admin-ui-api/services/data-service#dataservice'>DataService</a>, changeDetectorRef: ChangeDetectorRef) => ZoneSelectorComponent`} />
  51. ### onChange
  52. <MemberInfo kind="method" type={`(selected: <a href='/reference/typescript-api/entities/zone#zone'>Zone</a>) => `} />
  53. ### registerOnChange
  54. <MemberInfo kind="method" type={`(fn: any) => `} />
  55. ### registerOnTouched
  56. <MemberInfo kind="method" type={`(fn: any) => `} />
  57. ### setDisabledState
  58. <MemberInfo kind="method" type={`(isDisabled: boolean) => void`} />
  59. ### focus
  60. <MemberInfo kind="method" type={`() => `} />
  61. ### writeValue
  62. <MemberInfo kind="method" type={`(obj: string | <a href='/reference/typescript-api/entities/zone#zone'>Zone</a> | null) => void`} />
  63. </div>