首页
/ Farbtastic 技术文档

Farbtastic 技术文档

2024-12-16 15:00:53作者:尤辰城Agatha

1. 安装指南

为了使用 Farbtastic 插件,您需要遵循以下步骤:

  1. 确保您的页面已经包含了 jQuery 库。

  2. 下载 Farbtastic 插件文件 farbtastic.js

  3. 在 HTML 文件的 <head> 部分或页面的底部,包含这个 JavaScript 文件:

    <script type="text/javascript" src="farbtastic.js"></script>
    
  4. 如果您使用的是不支持 HTML5 canvas 元素的浏览器(如 Internet Explorer),则需要包含 Explorer Canvas polyfill。

2. 项目的使用说明

基本使用

  1. 在您的 HTML 中包含一个用于显示颜色选择器的 <div> 元素和一个文本输入框,并为它们设置唯一的 ID:

    <form>
      <input type="text" id="color" name="color" value="#123456" />
    </form>
    <div id="colorpicker"></div>
    
  2. 在文档的 ready() 事件中初始化颜色选择器,并将其与文本输入框相连接:

    $(document).ready(function() {
      $('#colorpicker').farbtastic('#color');
    });
    

高级使用

jQuery 方法

使用 $(...).farbtastic() 可以在选定的对象中创建颜色选择器。callback 是可选的,可以是:

  • DOM 节点、jQuery 对象或 jQuery 选择器:颜色选择器将同步选中元素的值(对于表单元素)和颜色。
  • 函数:每次用户选择不同的颜色时,这个函数将被调用。

对象方法

$.farbtastic(placeholder) 与使用 $(placeholder).farbtastic() 相同,但它返回的是一个 Farbtastic 对象而不是 jQuery 对象。这允许您使用下面的 Farbtastic 方法和属性。注意,每个占位符只有一个 Farbtastic 对象。如果使用相同的占位符两次调用 $.farbtastic(placeholder),每次都会得到相同的对象。

可选的回调参数的行为与 jQuery 方法中的相同。

选项

$(...).farbtastic(options)$.farbtastic(placeholder, options) 允许您传递除了回调之外的其他选项。可能的选项包括:

  • callback: 如前所述的回调。
  • height: 小部件的高度。
  • width: 小部件的宽度。

例如:$(...).farbtastic({ callback: '#color2', width: 150 })

方法

  • .linkTo(callback):允许您设置一个新的回调。任何现有的回调将被移除。
  • .setColor(string):将选择器的颜色设置为给定的十六进制颜色。
  • .setColor([h, s, l]):将选择器的颜色设置为规范化的 HSL 颜色(0..1 的比例)。

属性

  • .linked:此选择器链接到的元素(jQuery 对象)或回调函数。
  • .color:当前的十六进制颜色表示。
  • .hsl:当前的规范化 HSL 颜色。

3. 项目 API 使用文档

请参考上文中的“高级使用”部分,其中详细介绍了如何使用 Farbtastic 提供的 API 方法。

4. 项目安装方式

项目的安装方式已在“安装指南”部分进行了说明。请按照给定步骤下载并包含必要的 JavaScript 文件。

热门项目推荐
相关项目推荐

项目优选

收起
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
256
63
mybatis-plusmybatis-plus
mybatis 增强工具包,简化 CRUD 操作。 文档 http://baomidou.com 低代码组件库 http://aizuda.com
Java
19
0
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
175
42
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
49
39
open-eBackupopen-eBackup
open-eBackup是一款开源备份软件,采用集群高扩展架构,通过应用备份通用框架、并行备份等技术,为主流数据库、虚拟化、文件系统、大数据等应用提供E2E的数据备份、恢复等能力,帮助用户实现关键数据高效保护。
HTML
73
54
RuoYi-Cloud-Vue3RuoYi-Cloud-Vue3
🎉 基于Spring Boot、Spring Cloud & Alibaba、Vue3 & Vite、Element Plus的分布式前后端分离微服务架构权限管理系统
Vue
26
18
redis-sdkredis-sdk
仓颉语言实现的Redis客户端SDK。已适配仓颉0.53.4 Beta版本。接口设计兼容jedis接口语义,支持RESP2和RESP3协议,支持发布订阅模式,支持哨兵模式和集群模式。
Cangjie
406
46
advanced-javaadvanced-java
Advanced-Java是一个Java进阶教程,适合用于学习Java高级特性和编程技巧。特点:内容深入、实例丰富、适合进阶学习。
JavaScript
397
102
HarmonyOS-Cangjie-CasesHarmonyOS-Cangjie-Cases
参考 HarmonyOS-Cases/Cases,提供仓颉开发鸿蒙 NEXT 应用的案例集
Cangjie
55
2
RuoYi-VueRuoYi-Vue
🎉 基于SpringBoot,Spring Security,JWT,Vue & Element 的前后端分离权限管理系统,同时提供了 Vue3 的版本
Java
168
37