Skip to content

Repository files navigation

RandomColor for Dart & Flutter

CircleCIGithub Code SizeGithub LicensePub version

Generate visually appealing random colors with ease in your Dart and Flutter projects.

Demo

Interactive Demo

Table of Contents

Features

  • Generate random colors with fine-tuned control
  • Specify color types, luminosity, and output formats
  • Direct integration with Flutter's Color class
  • Highly customizable with easy-to-use API
  • Consistent results across platforms

Installation

Add this to your package's pubspec.yaml file:

dependencies:
flutter_randomcolor: ^1.0.16

Then run:

$ flutter pub get

Quick Start

import'package:flutter_randomcolor/flutter_randomcolor.dart';
// Generate a random colorvar color =RandomColor.getColor(Options());
// Generate a Flutter Color objectColor flutterColor =RandomColor.getColorObject(Options());

Usage Guide

Basic Usage

Generate a random color with default options:

var color =RandomColor.getColor(Options());

Flutter Integration

Get a Color object for direct use in Flutter widgets:

Color widgetColor =RandomColor.getColorObject(Options(
colorType:ColorType.blue,
luminosity:Luminosity.light,
));
// Use in a widgetContainer(
color: widgetColor,
child:Text('Colored Container'),
)

Advanced Options

Fine-tune your color generation:

var customColor =RandomColor.getColor(Options(
colorType: [ColorType.red, ColorType.blue],
luminosity:Luminosity.dark,
format:Format.rgba,
alpha:0.8,
));

API Reference

RandomColor.getColor(Options options)

Returns a color based on the specified options.

RandomColor.getColorObject(Options options)

Returns a Flutter Color object based on the specified options.

Options class

  • colorType: ColorType or List<ColorType>
  • luminosity: Luminosity
  • format: Format
  • alpha: double (0.0 to 1.0)
  • count: int

ColorType

random, monochrome, red, orange, yellow, green, blue, purple, pink

Luminosity

random, dark, light, bright

Format

rgba, rgb, rgbArray, hsla, hex, hsl, hsva, hsvArray, hslArray

Examples

// Bright green color in hex formatvar brightGreen =RandomColor.getColor(Options(
colorType:ColorType.green,
luminosity:Luminosity.bright,
format:Format.hex
));
// Array of 5 pastel colorsvar pastelColors =RandomColor.getColor(Options(
luminosity:Luminosity.light,
count:5
));
// Dark red or blue with 50% opacityvar transparentDark =RandomColor.getColor(Options(
colorType: [ColorType.red, ColorType.blue],
luminosity:Luminosity.dark,
format:Format.rgba,
alpha:0.5
));
// Flutter Color with seed options to return the same colorvar seedColor =RandomColor.getColorObject(Options(
colorType:ColorType.red,
luminosity:Luminosity.dark,
format:Format.hex,
seed:1234
));

Contributing

We welcome contributions! Please see our Contributing Guide for more details.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgements


Available in Other Languages

About

A dart package for generating attractive random colors. it can be used for generative art, data visualization and lot more.

Topics

Resources

Stars

14 stars

Watchers

3 watching

Forks

Releases

Packages

Contributors

Languages