KindEditor/基礎(chǔ)API

• K.VERSION

當前KindEditor的版本號。

Note：

當前瀏覽器的版本號為 K.V 。

• K.IE

當前瀏覽器內(nèi)核為IE時true，否則false。

• K.GECKO

當前瀏覽器內(nèi)核為Gecko（Firefox）時true，否則false。

• K.WEBKIT

當前瀏覽器內(nèi)核為Webkit（Safari、Chrome）時true，否則false。

• K.OPERA

當前瀏覽器內(nèi)核為Opera時true，否則false。

• K.MOBILE

當前瀏覽器為移動設(shè)備上的瀏覽器時true，否則false。

• K.QUIRKS

true時怪異模式，false時標準模式。

• K.V

當前瀏覽器的版本號。

• K.TIME

加載JS時的時間。

• K.isArray(val)

判斷一個變量是否數(shù)組。

參數(shù):

mixed val: 目標變量

返回: 當變量為數(shù)組時返回true，否則返回false。

示例:

bool = K.isArray([1, 2, 3]); //返回true
bool = K.isArray({one : 1}); //返回false

• K.isFunction(val)

判斷一個變量是不是函數(shù)。

參數(shù):

mixed val: 目標變量

返回: 當變量為函數(shù)時返回true，否則返回false。

示例:

bool = K.isFunction(function () { }); //返回true
bool = K.isFunction({}); //返回false

• K.inArray(val , arr)

查找一個變量在一個數(shù)組中第一次出現(xiàn)的索引位置。

參數(shù):

1. mixed val: 任意變量
2. array arr: 數(shù)組

返回: 返回第一次出現(xiàn)的索引位置，如果沒找到，則返回-1。

示例:

index = K.inArray(2, [1, 2, 3]); //返回1
index = K.inArray(1, [1, 2, 3]); //返回0
index = K.inArray(10, [1, 2, 3]); //返回-1

• K.each(obj , fn)

遍歷一個對象或數(shù)組。

參數(shù):

1. object|array obj: 目標對象或數(shù)組
2. function fn: 回調(diào)函數(shù)，回調(diào)函數(shù)的第一個參數(shù)為key，第二個參數(shù)為value。

返回: 無

示例:

//遍歷數(shù)組
K.each([1, 2, 3], function (i) {
        console.log(i + ':' + this);
});
//遍歷對象
K.each({one : 1, two : 2}, function (key, val) {
        console.log(key + ':' + val);
});

• K.trim(obj , fn)

清除字符串兩邊的空白。

參數(shù):

string str: 目標字符串

返回: string

示例:

var str = K.trim(' abc '); //返回"abc"

• K.inString(val , str [, delimiter])

判斷一個字符串是否包含在目標字符串里。

參數(shù):

1. string val: 要判斷的字符串
2. string str: 用delimiter分隔的目標字符串
3. string delimiter: 分隔符，默認值為逗號(,)。

返回: boolean

示例:

bool = K.inString('aaa', 'abc,aaa,bbb,ccc'); //返回true
bool = K.inString('aaa', 'abc aaa bbb ccc', ' '); //返回true

• K.addUnit(val [, unit])

一個數(shù)字后面添加指定字符串，如果val不是數(shù)字則返回原值。

參數(shù):

1. string val: 任意數(shù)字或字符串
2. string str: 單位，默認值為px

返回: string

示例:

width = K.addUnit(100); //返回"100px"
width = K.addUnit('100px'); //返回"100px"
width = K.addUnit('80%'); //返回"80%"
width = K.addUnit(80, '%'); //返回"80%"
width = K.addUnit(''); //返回""
width = K.addUnit(null); //返回null

• K.removeUnit(val)

從一個字符串中提取數(shù)字，如果該字符串中沒有數(shù)字則返回0。

參數(shù):

int|string val: 任意字符串

返回: int

示例:

width = K.removeUnit('100px'); //返回100
width = K.removeUnit(''); //返回0
width = K.removeUnit(null); //返回0

• K.escape(val)

將特殊字符轉(zhuǎn)換成HTML entities。

參數(shù):

string val: 任意字符串

返回: string

示例:

var str = K.escape('<div id="abc">&</div>'); //返回"<div id="abc">&</div>"

• K.unescape(val)

將特殊HTML entities轉(zhuǎn)換成字符。

參數(shù):

string val: 任意字符串

返回: string

示例:

var str = K.unescape('<div id="abc">&</div>'); //返回"<div id="abc">&</div>"

• K.toCamel(val)

將to-camel格式的字符串轉(zhuǎn)換成toCamel格式。

參數(shù):

string val:

返回: string

示例:

str = K.toCamel('font-weight'); //返回"fontWeight"

• K.toHex(val)

將任意字符串中的RGB顏色轉(zhuǎn)換成16進制顏色。

參數(shù):

string val: 包含RGB顏色的字符串

返回: string 16進制顏色

示例:

var hex = K.toHex('rgb(0, 0, 0)'); //返回"#000000"

• K.toMap(val [, delimiter])

將一個字符串或數(shù)字轉(zhuǎn)換成key-value對象。

參數(shù):

1. string|array val: 字符串或者數(shù)組，字符串時用delimiter分隔的字符串
2. string delimiter: 分隔符，當val為字符串時有效，默認值為逗號(,)

返回: object

示例:

map = K.toMap('abc,aaa,bbb'); //返回{abc : true, aaa : true, bbb : true}
map = K.toMap('abc-aaa-bbb', '-'); //返回{abc : true, aaa : true, bbb : true}
map = K.toMap(['abc', 'aaa', 'bbb']); //返回{abc : true, aaa : true, bbb : true}

• K.toArray(obj [, offset])

將一個數(shù)組風格對象轉(zhuǎn)換成真正的數(shù)組。

參數(shù):

object obj: 任意對象

返回: array

示例:

var arr = K.toArray(document.getElementsByTagName('div'));

• K.undef(val , defaultVal)

當val為undefined時返回defaultVal，否則返回val。

參數(shù):

mixed val: 任意變量

返回: val或defaultVal

示例:

val = K.undef(1, 0); //返回1
var obj = {};
val = K.undef(obj.aaa, 0); //返回0

• K.invalidUrl(val)

判斷URL或路徑是否合法。

參數(shù):

string val: URL或路徑

返回: boolean

示例:

val = K.invalidUrl('abc<">.html'); //返回true
val = K.invalidUrl('abc.html'); //返回false

• K.addParam(url, param)

URL添加GET參數(shù)，拼接時自動判斷連接字符(&或?)。

參數(shù):

1. string url: URL
2. string param: GET參數(shù)

返回: boolean

示例:

url = K.addParam('http://www.example.com/test.php', 'abc=123');
url = K.addParam('http://www.example.com/test.php?cde=456', 'abc=123');

• K.extend(fn , proto)

創(chuàng)建class。

參數(shù):

1. function fn: Function
2. object proto: fn的prototype

返回: undefined

示例:

function Animal() {
        this.init();
}
K.extend(Animal, {
        init : function() {
                console.log('init animal.');
        },
        run : function() {
                console.log('animal is running.');
        }
});
var animal = new Animal();
animal.run();

• K.extend(child , parent , proto)

繼承class。

參數(shù):

1. function child: 子類
2. function parent: 父類
3. object proto: 子類的prototype

返回: undefined

示例:

// create Animal class
function Animal(name) {
        this.init(name);
}
K.extend(Animal, {
        init : function(name) {
                this.name = name;
        },
        run : function() {
                console.log(this.name + ' is running.');
        }
});
// create Cat class
function Cat(name, age) {
        this.init(name, age);
}
K.extend(Cat, Animal, {
        init : function(name, age) {
                Cat.parent.init.call(this, name);
                this.age = age;
        }
});
var myCat = new Cat('Tony', 5);
console.log(myCat.name); // print 'Tony'
console.log(myCat.age); // print 5
myCat.run(); // print 'Tony is running.'

• K.json(text)

將JSON字符串轉(zhuǎn)換成JSON對象。

參數(shù):

string text: JSON字符串

返回: object JSON對象

示例:

var obj = K.json('{"a", 0}'); //返回{a : 0}

參考來源

• http://www.kindsoft.net/doc.php

KindEditor使用手冊導(dǎo)航
使用方法 初始化參數(shù) 添加自定義插件 API文檔： 基礎(chǔ)API|事件API|選擇器API|Node API|Range API|Command API|Ajax API|其它幾種API 常見問題