Back to Vendure

ZoneSelectorComponent

docs/docs/reference/admin-ui-api/components/zone-selector-component.mdx

3.6.32.5 KB
Original Source
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/components/zone-selector/zone-selector.component.ts" sourceLine="40" packageName="@vendure/admin-ui" />

A form control for selecting zones.

ts
class ZoneSelectorComponent implements ControlValueAccessor {
    @Output() selectedValuesChange = new EventEmitter<Zone>();
    @Input() readonly = false;
    @Input() transformControlValueAccessorValue: (value: Zone | undefined) => any = value => value?.id;
    selectedId$ = new Subject<string>();
    onChangeFn: (val: any) => void;
    onTouchFn: () => void;
    disabled = false;
    value: string | Zone;
    zones$ = this.dataService
        .query(GetZoneSelectorListDocument, { options: { take: 999 } })
        .mapSingle(result => result.zones.items);
    constructor(dataService: DataService, changeDetectorRef: ChangeDetectorRef)
    onChange(selected: Zone) => ;
    registerOnChange(fn: any) => ;
    registerOnTouched(fn: any) => ;
    setDisabledState(isDisabled: boolean) => void;
    focus() => ;
    writeValue(obj: string | Zone | null) => void;
}
  • Implements: ControlValueAccessor
<div className="members-wrapper">

selectedValuesChange

<MemberInfo kind="property" type={``} />

readonly

<MemberInfo kind="property" type={``} />

transformControlValueAccessorValue

<MemberInfo kind="property" type={(value: <a href='/reference/typescript-api/entities/zone#zone'>Zone</a> | undefined) => any} />

selectedId$

<MemberInfo kind="property" type={``} />

onChangeFn

<MemberInfo kind="property" type={(val: any) => void} />

onTouchFn

<MemberInfo kind="property" type={() => void} />

disabled

<MemberInfo kind="property" type={``} />

value

<MemberInfo kind="property" type={string | <a href='/reference/typescript-api/entities/zone#zone'>Zone</a>} />

zones$

<MemberInfo kind="property" type={``} />

onChange

<MemberInfo kind="method" type={(selected: <a href='/reference/typescript-api/entities/zone#zone'>Zone</a>) => } />

registerOnChange

<MemberInfo kind="method" type={(fn: any) => } />

registerOnTouched

<MemberInfo kind="method" type={(fn: any) => } />

setDisabledState

<MemberInfo kind="method" type={(isDisabled: boolean) => void} />

focus

<MemberInfo kind="method" type={() => } />

writeValue

<MemberInfo kind="method" type={(obj: string | <a href='/reference/typescript-api/entities/zone#zone'>Zone</a> | null) => void} />

</div>