square static method

Widget square({
  1. required Color currentColour,
  2. required ValueChanged<Color> onColorChanged,
  3. HSVColour? pickerHsvColor,
  4. ValueChanged<HSVColor>? onHsvColorChanged,
  5. PaletteType paletteType = PaletteType.hueWheel,
  6. bool enableAlpha = true,
  7. bool showLabel = true,
  8. List<ColorLabelType> labelTypes = const [ColorLabelType.rgb, ColorLabelType.hex],
  9. bool displayThumbColor = true,
  10. bool portraitOnly = false,
  11. double colorPickerWidth = 300,
  12. double pickerAreaHeightPercent = 1.0,
  13. bool hexInputBar = false,
  14. TextEditingController? hexInputController,
  15. BorderRadius? pickerAreaBorderRadius,
  16. List<Color>? colorHistory,
  17. ValueChanged<List<Color>>? onHistoryChanged,
})

Creates a square palette colour picker.

The square renders a 2D gradient based on the chosen paletteType. For instance, PaletteType.hsvWithHue shows saturation on the X-axis and value on the Y-axis, with a separate hue slider alongside.

  • paletteType selects which two components are shown on the square axes and which one gets its own slider.
  • colorPickerWidth sets the width (and, via pickerAreaHeightPercent, the height) of the palette area.
  • colorHistory and onHistoryChanged enable a tappable history strip of previously selected colours.

Implementation

static Widget square({
  required Color currentColour,
  required ValueChanged<Color> onColorChanged,
  HSVColour? pickerHsvColor,
  ValueChanged<HSVColor>? onHsvColorChanged,
  PaletteType paletteType = PaletteType.hueWheel,
  bool enableAlpha = true,
  bool showLabel = true,
  List<ColorLabelType> labelTypes = const [
    ColorLabelType.rgb,
    ColorLabelType.hex,
  ],
  bool displayThumbColor = true,
  bool portraitOnly = false,
  double colorPickerWidth = 300,
  double pickerAreaHeightPercent = 1.0,
  bool hexInputBar = false,
  TextEditingController? hexInputController,
  BorderRadius? pickerAreaBorderRadius,
  List<Color>? colorHistory,
  ValueChanged<List<Color>>? onHistoryChanged,
}) {
  return SquarePicker(
    currentColour: currentColour,
    onColorChanged: onColorChanged,
    pickerHsvColor: pickerHsvColor,
    onHsvColorChanged: onHsvColorChanged,
    paletteType: paletteType,
    enableAlpha: enableAlpha,
    showLabel: showLabel,
    labelTypes: labelTypes,
    displayThumbColor: displayThumbColor,
    portraitOnly: portraitOnly,
    colorPickerWidth: colorPickerWidth,
    pickerAreaHeightPercent: pickerAreaHeightPercent,
    colorHistory: colorHistory,
    onHistoryChanged: onHistoryChanged,
  );
}