facet-value-selector-component.mdx 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154
  1. ---
  2. title: "FacetValueSelectorComponent"
  3. generated: true
  4. ---
  5. ## FacetValueSelectorComponent
  6. <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/components/facet-value-selector/facet-value-selector.component.ts" sourceLine="34" packageName="@vendure/admin-ui" />
  7. A form control for selecting facet values.
  8. *Example*
  9. ```HTML
  10. <vdr-facet-value-selector
  11. (selectedValuesChange)="selectedValues = $event"
  12. ></vdr-facet-value-selector>
  13. ```
  14. The `selectedValuesChange` event will emit an array of `FacetValue` objects.
  15. ```ts title="Signature"
  16. class FacetValueSelectorComponent implements OnInit, OnDestroy, ControlValueAccessor {
  17. @Output() selectedValuesChange = new EventEmitter<FacetValueFragment[]>();
  18. @Input() readonly = false;
  19. @Input() transformControlValueAccessorValue: (value: FacetValueFragment[]) => any[] = value => value;
  20. searchInput$ = new Subject<string>();
  21. searchLoading = false;
  22. searchResults$: Observable<FacetValueFragment[]>;
  23. selectedIds$ = new Subject<string[]>();
  24. onChangeFn: (val: any) => void;
  25. onTouchFn: () => void;
  26. disabled = false;
  27. value: Array<string | FacetValueFragment>;
  28. constructor(dataService: DataService, changeDetectorRef: ChangeDetectorRef)
  29. ngOnInit() => void;
  30. ngOnDestroy() => ;
  31. onChange(selected: FacetValueFragment[]) => ;
  32. registerOnChange(fn: any) => ;
  33. registerOnTouched(fn: any) => ;
  34. setDisabledState(isDisabled: boolean) => void;
  35. focus() => ;
  36. writeValue(obj: string | FacetValueFragment[] | Array<string | number> | null) => void;
  37. }
  38. ```
  39. * Implements: <code>OnInit</code>, <code>OnDestroy</code>, <code>ControlValueAccessor</code>
  40. <div className="members-wrapper">
  41. ### selectedValuesChange
  42. <MemberInfo kind="property" type={``} />
  43. ### readonly
  44. <MemberInfo kind="property" type={``} />
  45. ### transformControlValueAccessorValue
  46. <MemberInfo kind="property" type={`(value: FacetValueFragment[]) => any[]`} />
  47. ### searchInput$
  48. <MemberInfo kind="property" type={``} />
  49. ### searchLoading
  50. <MemberInfo kind="property" type={``} />
  51. ### searchResults$
  52. <MemberInfo kind="property" type={`Observable<FacetValueFragment[]>`} />
  53. ### selectedIds$
  54. <MemberInfo kind="property" type={``} />
  55. ### onChangeFn
  56. <MemberInfo kind="property" type={`(val: any) => void`} />
  57. ### onTouchFn
  58. <MemberInfo kind="property" type={`() => void`} />
  59. ### disabled
  60. <MemberInfo kind="property" type={``} />
  61. ### value
  62. <MemberInfo kind="property" type={`Array<string | FacetValueFragment>`} />
  63. ### constructor
  64. <MemberInfo kind="method" type={`(dataService: <a href='/reference/admin-ui-api/services/data-service#dataservice'>DataService</a>, changeDetectorRef: ChangeDetectorRef) => FacetValueSelectorComponent`} />
  65. ### ngOnInit
  66. <MemberInfo kind="method" type={`() => void`} />
  67. ### ngOnDestroy
  68. <MemberInfo kind="method" type={`() => `} />
  69. ### onChange
  70. <MemberInfo kind="method" type={`(selected: FacetValueFragment[]) => `} />
  71. ### registerOnChange
  72. <MemberInfo kind="method" type={`(fn: any) => `} />
  73. ### registerOnTouched
  74. <MemberInfo kind="method" type={`(fn: any) => `} />
  75. ### setDisabledState
  76. <MemberInfo kind="method" type={`(isDisabled: boolean) => void`} />
  77. ### focus
  78. <MemberInfo kind="method" type={`() => `} />
  79. ### writeValue
  80. <MemberInfo kind="method" type={`(obj: string | FacetValueFragment[] | Array<string | number> | null) => void`} />
  81. </div>