QColorpicker

Being used to pick color value.

When to use

• When you need to pick a color as value.

Example

Default view:

Using in template:

<q-color-picker v-model="color" />

Using in component instance:

  setup() {
    const color = ref('#f25');

    return { color };
  }

Props

modelValue

• Type: String
• Default: null

Binding value.

// import type from lib
import type { QDatePickerPropModelValue } from '@qvant/qui-max';

// TS type
type QDatePickerPropModelValue = Nullable<string | Date | string[] | Date[]>;

popperOptions

• Type: Object
• Default: null

We use Popper.js to show tooltips & popovers. See full options guide here

export type QColorPickerPropPopperOptions = Nullable<Partial<Options>>;

export declare type Options = {
  placement: Placement;
  modifiers: Array<Partial<Modifier<any, any>>>;
  strategy: PositioningStrategy;
  onFirstUpdate?: (arg0: Partial<State>) => void;
};

disabled

• Type: Boolean
• Default: false

Whether to disable the ColorPicker.

<q-color-picker
  v-model="color"
  disabled
/>

clearable

• Type: Boolean
• Default: true

Whether to show clear button.

<q-color-picker
  v-model="color"
  clearable
/>

alphaShown

• Type: Boolean
• Default: false

Whether to display the alpha slider.

<q-color-picker
  v-model="color"
  alpha-shown
/>

colorFormat

• Type: 'hex' | 'rgb'
• Default: 'hex'

Output color format.

<q-color-picker
  v-model="color"
  color-format="rgb"
/>

placement

• Type: String
• Default: 'right-start'

Sets picker placement around the button.

<q-color-picker
  v-model="color"
  placement="bottom"
/>

// ts type
type Placement = AutoPlacement | BasePlacement | VariationPlacement;
type AutoPlacement = 'auto' | 'auto-start' | 'auto-end';
type BasePlacement = 'top' | 'bottom' | 'right' | 'left';
type VariationPlacement =
  | 'top-start'
  | 'top-end'
  | 'bottom-start'
  | 'bottom-end'
  | 'right-start'
  | 'right-end'
  | 'left-start'
  | 'left-end';

teleportTo

• Type String, HTMLElement
• Default: null

Specifies a target element where QColorpicker will be moved from original layout place. (has to be a valid query selector, or an HTMLElement).

<q-color-picker
  v-model="modelValue"
  teleport-to="body"
/>

Events

update:modelValue

Triggers when model updates.

change

Alias for update:modelValue.

Slots

trigger

Optional. HTML element that triggers dropdown

<q-color-picker v-model="color">
  <template v-slot:trigger>
    <q-button size="small">Custom trigger</q-button>
  </template>
</q-color-picker>