阿西河

所有教程

公众号
🌙
阿西河前端的公众号

我的收藏

    最近访问  (文章)

      教程列表

      抓包专区
      测试专区

      插件 jQuery.minicolors 中文API文档

      插件 jQuery.minicolors 中文API文档

      一个基于jQuery构建的小型颜色选择器

      API

      Instantiation

      Instantiate like any other jQuery plugin:

      $('INPUT.minicolors').minicolors(settings);
      
      

      Settings

      Default settings are as follows:

      $.minicolors = {
        defaults: {
          animationSpeed: 50,
          animationEasing: 'swing',
          change: null,
          changeDelay: 0,
          control: 'hue',
          defaultValue: '',
          format: 'hex',
          hide: null,
          hideSpeed: 100,
          inline: false,
          keywords: '',
          letterCase: 'lowercase',
          opacity: false,
          position: 'bottom left',
          show: null,
          showSpeed: 100,
          theme: 'default',
          swatches: []
        }
      };
      

      For convenience, you can change default settings globally by assigning new values:

      $.minicolors.defaults.changeDelay = 200;
      

      To change multiple properties at once, use $.extend():

      $.minicolors.defaults = $.extend($.minicolors.defaults, {
        changeDelay: 200,
        letterCase: 'uppercase',
        theme: 'bootstrap'
      });
      

      Note: Changing default settings will not affect controls that are already initialized.

      animationSpeed

      The animation speed of the sliders when the user taps or clicks a new color. Set to 0 for no animation.

      animationEasing

      The easing to use when animating the sliders.

      changeDelay

      The time, in milliseconds, to defer the change event from firing while the user makes a selection. This is useful for preventing the change event from firing frequently as the user drags the color picker around.

      The default value is 0 (no delay). If your change callback features something resource-intensive (such as an AJAX request), you’ll probably want to set this to at least 200.

      control

      Determines the type of control. Valid options are hue, brightness, saturation, and wheel.

      defaultValue To force a default color, set this to a valid hex string. When the user clears the control, it will revert to this color.

      format

      The format miniColors should use. Valid options are hex and rgb.

      hideSpeed & showSpeed The speed at which to hide and show the color picker.

      inline

      Set to true to force the color picker to appear inline.

      keywords

      A comma-separated list of keywords that the control should accept (e.g. inherit, transparent, initial). By default, no keywords are allowed.

      letterCase

      Determines the letter case of the hex code value. Valid options are uppercase or lowercase.

      opacity

      Set to true to enable the opacity slider. (Use the input element’s data-opacity attribute to set a preset value.)

      position

      Sets the position of the dropdown. Valid options are bottom left, bottom right, top left, and top right.

      The swatchPosition setting has been removed in version 2.1. The position of the swatch is now determined by position.

      theme

      A string containing the name of the custom theme to be applied. In your CSS, prefix your selectors like this:

      .minicolors-theme-yourThemeName { ... }
      

      If you are using the default theme, you will probably need to adjust the swatch styles depending on your existing stylesheet rules. Version 2.1 removes as much styling on the input element as possible, which means it’s up to you to adjust your CSS to make sure the swatch aligns properly.

      To adjust the swatch, override these styles:

      .minicolors-theme-default .minicolors-swatch {
        top: 5px;
        left: 5px;
        width: 18px;
        height: 18px;
      }
      .minicolors-theme-default.minicolors-position-right .minicolors-swatch {
        left: auto;
        right: 5px;
      }
      

      swatches

      An array containing one or more strings of hex colors that will show up under the main color grid.

      Alternatively, this can be an array of { name, color } objects where name is a human-readable color name and color is a hex code. In this case, the name will be used to set the swatch’s title attribute.

      Methods

      Use this syntax for calling methods:

      $(selector).minicolors('method', [data]);
      

      create Initializes the control for all items matching your selector. This is the default method, so data may be passed in as the only argument.

      To set a preset color value, populate the value attribute of the original input element.

      destroy

      Returns the input element to its original, uninitialized state.

      hide

      Hides the color picker.

      show

      Shows the color picker.

      opacity

      Gets or sets a control’s opacity level. To use this method as a setter, pass data in as a value between 0 and 1. (You can also obtain this value by checking the input element’s data-opacity attribute.)

      To set a preset opacity value, populate the data-opacity attribute of the original input element.

      rgbObject

      Returns an object containing red, green, blue, and alpha properties that correspond to the control’s current value. Example:

      { r: 0, g: 82, b: 148, a: 0.75 }
      

      rgbString & rgbaString

      Returns an RGB or RGBA string suitable for use in your CSS. Examples:

      rgb(0, 82, 148)
      rgba(0, 82, 148, .75)
      

      settings

      Gets or sets a control’s settings. If new settings are passed in, the control will destroy and re-initialize itself with any new settings overriding the old ones.

      value

      Gets or sets a control’s color value. To use this method as a setter, pass in a color string or an object (ex: {color: ‘#fc0’, opacity: .5}).

      Events

      change

      Fires when the value of the color picker changes. The this keyword will reference the original input element.

      $(selector).minicolors({
        change: function(value, opacity) {
          console.log(value + ' - ' + opacity);
        }
      });
      

      Warning! This event will fire a lot when the user drags the color picker around. Use the changeDelay setting to reduce its frequency.

      hide

      Fires when the color picker is hidden. The this keyword will reference the original input element.

      $(selector).minicolors({
        hide: function() {
        console.log('Hide event triggered!');
        }
      });
      

      show

      Fires when the color picker is shown. The this keyword will reference the original input element.

      $(selector).minicolors({
        show: function() {
          console.log('Show event triggered!');
        }
      });
      
      目录
      目录