@vuetify/nightly
Version:
Vue Material Component Framework
583 lines (581 loc) • 25 kB
TypeScript
// Styles
import { IconValue } from '../../composables/icons.js';
import { deepEqual } from '../../util/index.js';
// Types
import type { InjectionKey, PropType, Ref } from 'vue';
import type { GenericProps } from '../../util/index.js';
export interface VSelectionGroupContext {
modelValue: Ref<any>;
forceUpdate: () => void;
onForceUpdate: (fn: () => void) => void;
}
export declare const VSelectionControlGroupSymbol: InjectionKey<VSelectionGroupContext>;
export declare const makeSelectionControlGroupProps: <Defaults extends {
theme?: unknown;
class?: unknown;
style?: unknown;
density?: unknown;
color?: unknown;
disabled?: unknown;
defaultsTarget?: unknown;
error?: unknown;
id?: unknown;
inline?: unknown;
falseIcon?: unknown;
trueIcon?: unknown;
ripple?: unknown;
multiple?: unknown;
name?: unknown;
readonly?: unknown;
modelValue?: unknown;
type?: unknown;
valueComparator?: unknown;
} = {}>(defaults?: Defaults | undefined) => {
theme: unknown extends Defaults["theme"] ? StringConstructor : {
type: PropType<unknown extends Defaults["theme"] ? string : string | Defaults["theme"]>;
default: unknown extends Defaults["theme"] ? string : string | Defaults["theme"];
};
class: unknown extends Defaults["class"] ? PropType<any> : {
type: PropType<unknown extends Defaults["class"] ? any : any>;
default: unknown extends Defaults["class"] ? any : any;
};
style: unknown extends Defaults["style"] ? {
type: PropType<import("vue").StyleValue>;
default: null;
} : Omit<{
type: PropType<import("vue").StyleValue>;
default: null;
}, "default" | "type"> & {
type: PropType<unknown extends Defaults["style"] ? import("vue").StyleValue : Defaults["style"] | import("vue").StyleValue>;
default: unknown extends Defaults["style"] ? import("vue").StyleValue : Defaults["style"] | NonNullable<import("vue").StyleValue>;
};
density: unknown extends Defaults["density"] ? {
type: PropType<import("../../composables/density.js").Density>;
default: string;
validator: (v: any) => boolean;
} : Omit<{
type: PropType<import("../../composables/density.js").Density>;
default: string;
validator: (v: any) => boolean;
}, "default" | "type"> & {
type: PropType<unknown extends Defaults["density"] ? import("../../composables/density.js").Density : Defaults["density"] | import("../../composables/density.js").Density>;
default: unknown extends Defaults["density"] ? import("../../composables/density.js").Density : Defaults["density"] | NonNullable<import("../../composables/density.js").Density>;
};
color: unknown extends Defaults["color"] ? StringConstructor : {
type: PropType<unknown extends Defaults["color"] ? string : string | Defaults["color"]>;
default: unknown extends Defaults["color"] ? string : string | Defaults["color"];
};
disabled: unknown extends Defaults["disabled"] ? {
type: PropType<boolean | null>;
default: null;
} : Omit<{
type: PropType<boolean | null>;
default: null;
}, "default" | "type"> & {
type: PropType<unknown extends Defaults["disabled"] ? boolean | null : boolean | Defaults["disabled"] | null>;
default: unknown extends Defaults["disabled"] ? boolean | null : Defaults["disabled"] | NonNullable<boolean | null>;
};
defaultsTarget: unknown extends Defaults["defaultsTarget"] ? StringConstructor : {
type: PropType<unknown extends Defaults["defaultsTarget"] ? string : string | Defaults["defaultsTarget"]>;
default: unknown extends Defaults["defaultsTarget"] ? string : string | Defaults["defaultsTarget"];
};
error: unknown extends Defaults["error"] ? BooleanConstructor : {
type: PropType<unknown extends Defaults["error"] ? boolean : boolean | Defaults["error"]>;
default: unknown extends Defaults["error"] ? boolean : boolean | Defaults["error"];
};
id: unknown extends Defaults["id"] ? StringConstructor : {
type: PropType<unknown extends Defaults["id"] ? string : string | Defaults["id"]>;
default: unknown extends Defaults["id"] ? string : string | Defaults["id"];
};
inline: unknown extends Defaults["inline"] ? BooleanConstructor : {
type: PropType<unknown extends Defaults["inline"] ? boolean : boolean | Defaults["inline"]>;
default: unknown extends Defaults["inline"] ? boolean : boolean | Defaults["inline"];
};
falseIcon: unknown extends Defaults["falseIcon"] ? PropType<IconValue> : {
type: PropType<unknown extends Defaults["falseIcon"] ? IconValue : Defaults["falseIcon"] | IconValue>;
default: unknown extends Defaults["falseIcon"] ? IconValue : Defaults["falseIcon"] | NonNullable<IconValue>;
};
trueIcon: unknown extends Defaults["trueIcon"] ? PropType<IconValue> : {
type: PropType<unknown extends Defaults["trueIcon"] ? IconValue : Defaults["trueIcon"] | IconValue>;
default: unknown extends Defaults["trueIcon"] ? IconValue : Defaults["trueIcon"] | NonNullable<IconValue>;
};
ripple: unknown extends Defaults["ripple"] ? {
type: PropType<boolean | {
class?: string | undefined;
keys?: string[] | undefined;
} | undefined>;
default: boolean;
} : Omit<{
type: PropType<boolean | {
class?: string | undefined;
keys?: string[] | undefined;
} | undefined>;
default: boolean;
}, "default" | "type"> & {
type: PropType<unknown extends Defaults["ripple"] ? boolean | {
class?: string | undefined;
keys?: string[] | undefined;
} | undefined : boolean | {
class?: string | undefined;
keys?: string[] | undefined;
} | Defaults["ripple"] | undefined>;
default: unknown extends Defaults["ripple"] ? boolean | {
class?: string | undefined;
keys?: string[] | undefined;
} | undefined : Defaults["ripple"] | NonNullable<boolean | {
class?: string | undefined;
keys?: string[] | undefined;
} | undefined>;
};
multiple: unknown extends Defaults["multiple"] ? {
type: PropType<boolean | null>;
default: null;
} : Omit<{
type: PropType<boolean | null>;
default: null;
}, "default" | "type"> & {
type: PropType<unknown extends Defaults["multiple"] ? boolean | null : boolean | Defaults["multiple"] | null>;
default: unknown extends Defaults["multiple"] ? boolean | null : Defaults["multiple"] | NonNullable<boolean | null>;
};
name: unknown extends Defaults["name"] ? StringConstructor : {
type: PropType<unknown extends Defaults["name"] ? string : string | Defaults["name"]>;
default: unknown extends Defaults["name"] ? string : string | Defaults["name"];
};
readonly: unknown extends Defaults["readonly"] ? {
type: PropType<boolean | null>;
default: null;
} : Omit<{
type: PropType<boolean | null>;
default: null;
}, "default" | "type"> & {
type: PropType<unknown extends Defaults["readonly"] ? boolean | null : boolean | Defaults["readonly"] | null>;
default: unknown extends Defaults["readonly"] ? boolean | null : Defaults["readonly"] | NonNullable<boolean | null>;
};
modelValue: unknown extends Defaults["modelValue"] ? null : {
type: PropType<unknown extends Defaults["modelValue"] ? any : any>;
default: unknown extends Defaults["modelValue"] ? any : any;
};
type: unknown extends Defaults["type"] ? StringConstructor : {
type: PropType<unknown extends Defaults["type"] ? string : string | Defaults["type"]>;
default: unknown extends Defaults["type"] ? string : string | Defaults["type"];
};
valueComparator: unknown extends Defaults["valueComparator"] ? {
type: PropType<typeof deepEqual>;
default: typeof deepEqual;
} : Omit<{
type: PropType<typeof deepEqual>;
default: typeof deepEqual;
}, "default" | "type"> & {
type: PropType<unknown extends Defaults["valueComparator"] ? typeof deepEqual : typeof deepEqual | Defaults["valueComparator"]>;
default: unknown extends Defaults["valueComparator"] ? typeof deepEqual : typeof deepEqual | Defaults["valueComparator"];
};
};
export declare const makeVSelectionControlGroupProps: <Defaults extends {
theme?: unknown;
class?: unknown;
style?: unknown;
density?: unknown;
color?: unknown;
disabled?: unknown;
defaultsTarget?: unknown;
error?: unknown;
id?: unknown;
inline?: unknown;
falseIcon?: unknown;
trueIcon?: unknown;
ripple?: unknown;
multiple?: unknown;
name?: unknown;
readonly?: unknown;
modelValue?: unknown;
type?: unknown;
valueComparator?: unknown;
} = {}>(defaults?: Defaults | undefined) => {
theme: unknown extends Defaults["theme"] ? StringConstructor : {
type: PropType<unknown extends Defaults["theme"] ? string : string | Defaults["theme"]>;
default: unknown extends Defaults["theme"] ? string : string | Defaults["theme"];
};
class: unknown extends Defaults["class"] ? PropType<any> : {
type: PropType<unknown extends Defaults["class"] ? any : any>;
default: unknown extends Defaults["class"] ? any : any;
};
style: unknown extends Defaults["style"] ? {
type: PropType<import("vue").StyleValue>;
default: null;
} : Omit<{
type: PropType<import("vue").StyleValue>;
default: null;
}, "default" | "type"> & {
type: PropType<unknown extends Defaults["style"] ? import("vue").StyleValue : Defaults["style"] | import("vue").StyleValue>;
default: unknown extends Defaults["style"] ? import("vue").StyleValue : Defaults["style"] | NonNullable<import("vue").StyleValue>;
};
density: unknown extends Defaults["density"] ? {
type: PropType<import("../../composables/density.js").Density>;
default: string;
validator: (v: any) => boolean;
} : Omit<{
type: PropType<import("../../composables/density.js").Density>;
default: string;
validator: (v: any) => boolean;
}, "default" | "type"> & {
type: PropType<unknown extends Defaults["density"] ? import("../../composables/density.js").Density : Defaults["density"] | import("../../composables/density.js").Density>;
default: unknown extends Defaults["density"] ? import("../../composables/density.js").Density : Defaults["density"] | NonNullable<import("../../composables/density.js").Density>;
};
color: unknown extends Defaults["color"] ? StringConstructor : {
type: PropType<unknown extends Defaults["color"] ? string : string | Defaults["color"]>;
default: unknown extends Defaults["color"] ? string : string | Defaults["color"];
};
disabled: unknown extends Defaults["disabled"] ? {
type: PropType<boolean | null>;
default: null;
} : Omit<{
type: PropType<boolean | null>;
default: null;
}, "default" | "type"> & {
type: PropType<unknown extends Defaults["disabled"] ? boolean | null : boolean | Defaults["disabled"] | null>;
default: unknown extends Defaults["disabled"] ? boolean | null : Defaults["disabled"] | NonNullable<boolean | null>;
};
defaultsTarget: unknown extends Defaults["defaultsTarget"] ? {
type: PropType<string>;
default: string;
} : Omit<{
type: PropType<string>;
default: string;
}, "default" | "type"> & {
type: PropType<unknown extends Defaults["defaultsTarget"] ? string : string | Defaults["defaultsTarget"]>;
default: unknown extends Defaults["defaultsTarget"] ? string : string | Defaults["defaultsTarget"];
};
error: unknown extends Defaults["error"] ? BooleanConstructor : {
type: PropType<unknown extends Defaults["error"] ? boolean : boolean | Defaults["error"]>;
default: unknown extends Defaults["error"] ? boolean : boolean | Defaults["error"];
};
id: unknown extends Defaults["id"] ? StringConstructor : {
type: PropType<unknown extends Defaults["id"] ? string : string | Defaults["id"]>;
default: unknown extends Defaults["id"] ? string : string | Defaults["id"];
};
inline: unknown extends Defaults["inline"] ? BooleanConstructor : {
type: PropType<unknown extends Defaults["inline"] ? boolean : boolean | Defaults["inline"]>;
default: unknown extends Defaults["inline"] ? boolean : boolean | Defaults["inline"];
};
falseIcon: unknown extends Defaults["falseIcon"] ? PropType<IconValue> : {
type: PropType<unknown extends Defaults["falseIcon"] ? IconValue : Defaults["falseIcon"] | IconValue>;
default: unknown extends Defaults["falseIcon"] ? IconValue : Defaults["falseIcon"] | NonNullable<IconValue>;
};
trueIcon: unknown extends Defaults["trueIcon"] ? PropType<IconValue> : {
type: PropType<unknown extends Defaults["trueIcon"] ? IconValue : Defaults["trueIcon"] | IconValue>;
default: unknown extends Defaults["trueIcon"] ? IconValue : Defaults["trueIcon"] | NonNullable<IconValue>;
};
ripple: unknown extends Defaults["ripple"] ? {
type: PropType<boolean | {
class?: string | undefined;
keys?: string[] | undefined;
} | undefined>;
default: boolean;
} : Omit<{
type: PropType<boolean | {
class?: string | undefined;
keys?: string[] | undefined;
} | undefined>;
default: boolean;
}, "default" | "type"> & {
type: PropType<unknown extends Defaults["ripple"] ? boolean | {
class?: string | undefined;
keys?: string[] | undefined;
} | undefined : boolean | {
class?: string | undefined;
keys?: string[] | undefined;
} | Defaults["ripple"] | undefined>;
default: unknown extends Defaults["ripple"] ? boolean | {
class?: string | undefined;
keys?: string[] | undefined;
} | undefined : Defaults["ripple"] | NonNullable<boolean | {
class?: string | undefined;
keys?: string[] | undefined;
} | undefined>;
};
multiple: unknown extends Defaults["multiple"] ? {
type: PropType<boolean | null>;
default: null;
} : Omit<{
type: PropType<boolean | null>;
default: null;
}, "default" | "type"> & {
type: PropType<unknown extends Defaults["multiple"] ? boolean | null : boolean | Defaults["multiple"] | null>;
default: unknown extends Defaults["multiple"] ? boolean | null : Defaults["multiple"] | NonNullable<boolean | null>;
};
name: unknown extends Defaults["name"] ? StringConstructor : {
type: PropType<unknown extends Defaults["name"] ? string : string | Defaults["name"]>;
default: unknown extends Defaults["name"] ? string : string | Defaults["name"];
};
readonly: unknown extends Defaults["readonly"] ? {
type: PropType<boolean | null>;
default: null;
} : Omit<{
type: PropType<boolean | null>;
default: null;
}, "default" | "type"> & {
type: PropType<unknown extends Defaults["readonly"] ? boolean | null : boolean | Defaults["readonly"] | null>;
default: unknown extends Defaults["readonly"] ? boolean | null : Defaults["readonly"] | NonNullable<boolean | null>;
};
modelValue: unknown extends Defaults["modelValue"] ? null : {
type: PropType<unknown extends Defaults["modelValue"] ? any : any>;
default: unknown extends Defaults["modelValue"] ? any : any;
};
type: unknown extends Defaults["type"] ? StringConstructor : {
type: PropType<unknown extends Defaults["type"] ? string : string | Defaults["type"]>;
default: unknown extends Defaults["type"] ? string : string | Defaults["type"];
};
valueComparator: unknown extends Defaults["valueComparator"] ? {
type: PropType<typeof deepEqual>;
default: typeof deepEqual;
} : Omit<{
type: PropType<typeof deepEqual>;
default: typeof deepEqual;
}, "default" | "type"> & {
type: PropType<unknown extends Defaults["valueComparator"] ? typeof deepEqual : typeof deepEqual | Defaults["valueComparator"]>;
default: unknown extends Defaults["valueComparator"] ? typeof deepEqual : typeof deepEqual | Defaults["valueComparator"];
};
};
export declare const VSelectionControlGroup: {
new (...args: any[]): import("vue").CreateComponentPublicInstanceWithMixins<{
style: string | false | import("vue").StyleValue[] | import("vue").CSSProperties | null;
density: import("../../composables/density.js").Density;
disabled: boolean | null;
defaultsTarget: string;
error: boolean;
inline: boolean;
ripple: boolean | {
class?: string | undefined;
keys?: string[] | undefined;
};
multiple: boolean | null;
readonly: boolean | null;
valueComparator: typeof deepEqual;
} & {
theme?: string | undefined;
class?: any;
color?: string | undefined;
id?: string | undefined;
falseIcon?: IconValue | undefined;
trueIcon?: IconValue | undefined;
name?: string | undefined;
type?: string | undefined;
} & {}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Omit<{
"update:modelValue": (value: any) => true;
}, "$children" | "modelValue" | "update:modelValue" | "v-slot:default" | "v-slots">, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, {
style: import("vue").StyleValue;
density: import("../../composables/density.js").Density;
disabled: boolean | null;
defaultsTarget: string;
error: boolean;
inline: boolean;
ripple: boolean | {
class?: string | undefined;
keys?: string[] | undefined;
} | undefined;
multiple: boolean | null;
readonly: boolean | null;
valueComparator: typeof deepEqual;
}, true, {}, import("vue").SlotsType<Partial<{
default: () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
[key: string]: any;
}>[];
}>>, import("vue").GlobalComponents, import("vue").GlobalDirectives, string, {}, any, import("vue").ComponentProvideOptions, {
P: {};
B: {};
D: {};
C: {};
M: {};
Defaults: {};
}, {
style: string | false | import("vue").StyleValue[] | import("vue").CSSProperties | null;
density: import("../../composables/density.js").Density;
disabled: boolean | null;
defaultsTarget: string;
error: boolean;
inline: boolean;
ripple: boolean | {
class?: string | undefined;
keys?: string[] | undefined;
};
multiple: boolean | null;
readonly: boolean | null;
valueComparator: typeof deepEqual;
} & {
theme?: string | undefined;
class?: any;
color?: string | undefined;
id?: string | undefined;
falseIcon?: IconValue | undefined;
trueIcon?: IconValue | undefined;
name?: string | undefined;
type?: string | undefined;
} & {}, {}, {}, {}, {}, {
style: import("vue").StyleValue;
density: import("../../composables/density.js").Density;
disabled: boolean | null;
defaultsTarget: string;
error: boolean;
inline: boolean;
ripple: boolean | {
class?: string | undefined;
keys?: string[] | undefined;
} | undefined;
multiple: boolean | null;
readonly: boolean | null;
valueComparator: typeof deepEqual;
}>;
__isFragment?: undefined;
__isTeleport?: undefined;
__isSuspense?: undefined;
} & import("vue").ComponentOptionsBase<{
style: string | false | import("vue").StyleValue[] | import("vue").CSSProperties | null;
density: import("../../composables/density.js").Density;
disabled: boolean | null;
defaultsTarget: string;
error: boolean;
inline: boolean;
ripple: boolean | {
class?: string | undefined;
keys?: string[] | undefined;
};
multiple: boolean | null;
readonly: boolean | null;
valueComparator: typeof deepEqual;
} & {
theme?: string | undefined;
class?: any;
color?: string | undefined;
id?: string | undefined;
falseIcon?: IconValue | undefined;
trueIcon?: IconValue | undefined;
name?: string | undefined;
type?: string | undefined;
} & {}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Omit<{
"update:modelValue": (value: any) => true;
}, "$children" | "modelValue" | "update:modelValue" | "v-slot:default" | "v-slots">, string, {
style: import("vue").StyleValue;
density: import("../../composables/density.js").Density;
disabled: boolean | null;
defaultsTarget: string;
error: boolean;
inline: boolean;
ripple: boolean | {
class?: string | undefined;
keys?: string[] | undefined;
} | undefined;
multiple: boolean | null;
readonly: boolean | null;
valueComparator: typeof deepEqual;
}, {}, string, import("vue").SlotsType<Partial<{
default: () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
[key: string]: any;
}>[];
}>>, import("vue").GlobalComponents, import("vue").GlobalDirectives, string, import("vue").ComponentProvideOptions> & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps & (new <T>(props: {
modelValue?: T | undefined;
"onUpdate:modelValue"?: ((value: T) => void) | undefined;
}, slots: {
default: never;
}) => GenericProps<{
modelValue?: T | undefined;
"onUpdate:modelValue"?: ((value: T) => void) | undefined;
}, {
default: never;
}>) & import("../../util/index.js").FilterPropsOptions<{
theme: StringConstructor;
class: PropType<any>;
style: {
type: PropType<import("vue").StyleValue>;
default: null;
};
density: {
type: PropType<import("../../composables/density.js").Density>;
default: string;
validator: (v: any) => boolean;
};
color: StringConstructor;
disabled: {
type: PropType<boolean | null>;
default: null;
};
defaultsTarget: {
type: PropType<string>;
default: string;
};
error: BooleanConstructor;
id: StringConstructor;
inline: BooleanConstructor;
falseIcon: PropType<IconValue>;
trueIcon: PropType<IconValue>;
ripple: {
type: PropType<boolean | {
class?: string | undefined;
keys?: string[] | undefined;
} | undefined>;
default: boolean;
};
multiple: {
type: PropType<boolean | null>;
default: null;
};
name: StringConstructor;
readonly: {
type: PropType<boolean | null>;
default: null;
};
modelValue: null;
type: StringConstructor;
valueComparator: {
type: PropType<typeof deepEqual>;
default: typeof deepEqual;
};
}, import("vue").ExtractPropTypes<{
theme: StringConstructor;
class: PropType<any>;
style: {
type: PropType<import("vue").StyleValue>;
default: null;
};
density: {
type: PropType<import("../../composables/density.js").Density>;
default: string;
validator: (v: any) => boolean;
};
color: StringConstructor;
disabled: {
type: PropType<boolean | null>;
default: null;
};
defaultsTarget: {
type: PropType<string>;
default: string;
};
error: BooleanConstructor;
id: StringConstructor;
inline: BooleanConstructor;
falseIcon: PropType<IconValue>;
trueIcon: PropType<IconValue>;
ripple: {
type: PropType<boolean | {
class?: string | undefined;
keys?: string[] | undefined;
} | undefined>;
default: boolean;
};
multiple: {
type: PropType<boolean | null>;
default: null;
};
name: StringConstructor;
readonly: {
type: PropType<boolean | null>;
default: null;
};
modelValue: null;
type: StringConstructor;
valueComparator: {
type: PropType<typeof deepEqual>;
default: typeof deepEqual;
};
}>>;
export type VSelectionControlGroup = InstanceType<typeof VSelectionControlGroup>;