sit-onyx 1.0.0-beta.22 → 1.0.0-beta.23

package/dist/components/OnyxSelect/types.d.ts

@@ -12,21 +12,18 @@ export type SelectSearchProps = {
     withSearch: true;
     /**
      * Value of the search input.
-     * Property is managed internally, when undefined.
-     */
-    searchTerm?: string;
-    /**
-     * As default, onyx will handle the search by comparing
+     * Property is managed internally, when undefined. That means:
+     * As default, onyx will handle filtering the options by comparing
      * the option labels with the `searchTerm`.
-     * When `manualSearch` is set, this behavior is disabled.
-     * Handle your own filtering by reducing the `options` as desired.
+     *
+     * When `searchTerm` is handled by you (not undefined), this behavior is disabled.
+     * Then, you can handle the filtering yourself by reducing the `options` as desired.
      * Hint: Cover `valueLabel` to prevent the disappearance of the current selections label
      */
-    manualSearch?: boolean;
+    searchTerm?: string;
 } | {
     withSearch?: false;
     searchTerm?: never;
-    manualSearch?: never;
 };
 export type SelectModelValueProps<TValue extends SelectOptionValue> = {
     /**
@@ -60,7 +57,7 @@ export type SelectModelValueProps<TValue extends SelectOptionValue> = {
         label?: string;
     };
 };
-export type OnyxSelectProps<TValue extends SelectOptionValue = SelectOptionValue> = DensityProp & SelectModelValueProps<TValue> & SelectSearchProps & Omit<OnyxSelectInputProps, "density" | "modelValue"> & AutofocusProp & Pick<BaseSelectOption, "truncation"> & {
+export type OnyxSelectProps<TValue extends SelectOptionValue = SelectOptionValue> = DensityProp & SelectModelValueProps<TValue> & SelectSearchProps & Omit<OnyxSelectInputProps, "density" | "modelValue" | "showFocus"> & AutofocusProp & Pick<BaseSelectOption, "truncation"> & {
     /**
      * Label that will be shown in the input of OnyxSelect.
      * If unset, will be managed internally by comparing `modelValue` with `options`.
@@ -90,7 +87,8 @@ export type OnyxSelectProps<TValue extends SelectOptionValue = SelectOptionValue
 };
 export type SelectOption<TValue extends SelectOptionValue = SelectOptionValue> = Pick<BaseSelectOption<TValue>, "value" | "label" | "disabled" | "truncation"> & Pick<OnyxSelectOptionProps, "icon"> & {
     /**
-     * Optional group name. If set, all options will be grouped under that group name.
+     * Optional group name. If set, all options with the same group name will be grouped below that name.
+     * If `group` is used for one option, it should be used for all other options as well.
      */
     group?: string;
 };

package/dist/composables/useManagedState.d.ts

@@ -8,18 +8,21 @@ import { type Ref } from "vue";
  * @param prop `toRef(() => props.something)` ref of the optional prop.
  * @param initialState in case of the prop being initially undefined, this will be used as the initial state value.
  * @param emit function that is called when a state write is performed
- * @returns ref of the state
+ * @returns ref of the state and isManaged
  *
  * @example ```ts
  * // IMPORTANT: default value MUST be set to undefined
  * const props = withDefaults(defineProps<{ isExpanded?: boolean }>(), { isExpanded: undefined });
  * const emit = defineEmits<{ "update:isExpanded": [isExpanded: boolean] }>();
  *
- * const isExpanded = useManagedState(
+ * const { state: isExpanded } = useManagedState(
  *  toRef(() => props.isExpanded),
  *  false,
  *  (v) => emit("update:isExpanded", v ?? false),
  * );
  * ```
  */
-export declare const useManagedState: <Prop extends Readonly<Ref<T | undefined>>, T>(prop: Prop, initialState: T, emit: (val: T) => void) => import("vue").WritableComputedRef<T>;
+export declare const useManagedState: <Prop extends Readonly<Ref<T | undefined>>, T>(prop: Prop, initialState: T, emit: (val: T) => void) => {
+    state: import("vue").WritableComputedRef<T>;
+    isManaged: import("vue").ComputedRef<boolean>;
+};