API Docs for: 0.2
Show:

JC.Suggest Class

Suggest 关键词补全提示类

require: JC.BaseMVC

JC Project Site | API docs | demo link

可用的 HTML attribute

sugwidth: int
显示列表的宽度
suglayout: selector
显示列表的容器
sugdatacallback: string
请求 JSONP 数据的回调名
注意: 是字符串, 不是函数, 并且确保 window 下没有同名函数
suginitedcallback: string
初始化完毕后的回调名称
sugurl: string
数据请求 URL API
例: http://sug.so.360.cn/suggest/word?callback={1}&encodein=utf-8&encodeout=utf-8&word={0}
{0}=关键词, {1}=回调名称
sugqueryinterval: int, default = 300
设置用户输入内容时, 响应的间隔, 避免不必要的请求
sugneedscripttag: bool, default=true
是否需要 自动添加 script 标签
Sugggest 设计为支持三种数据格式: JSONP, AJAX, static data
目前只支持 JSONP 数据
sugselectedcallback: function
用户鼠标点击选择关键词后的回调
sugdatafilter: function
数据过滤回调
sugsubtagname: string, default = dd
显式定义 suggest 列表的子标签名
suglayouttpl: string
显式定义 suggest 列表显示模板
sugautoposition: bool, default = false
式声明是否要自动识别显示位置
sugoffsetleft: int, default = 0
声明显示时, x轴的偏移像素
sugoffsettop: int, default = 0
声明显示时, y轴的偏移像素
sugoffsetwidth: int, default = 0
首次初始化时, layout的偏移宽度
sugplaceholder: selector
声明自动定位时, 显示位置的占位符标签
sugprevententer: bool, default = false
回车时, 是否阻止默认事件, 为真将阻止表单提交事件
sugIdSelector = selector
保存 id 的选择器( 只有关键词为 json格式的时候才会生效, { id: 'string', name: 'string' } )

Constructor

JC.Suggest

(
  • _selector
)

Parameters:

Methods

_hideOther

(
  • _ins
)
private static

隐藏其他 Suggest 显示列表

Parameters:

  • _ins SuggestInstance

getInstance

(
  • _selector
  • _setter
)
Suggest instance static

获取或设置 Suggest 的实例

Parameters:

  • _selector Selector
  • _setter SuggestInstace | Null

Returns:

Suggest instance:

hide

()

隐藏 Suggest

Returns:

SuggestInstance

isSuggest

(
  • _selector
)
static

判断 selector 是否可以初始化 Suggest

Parameters:

  • _selector Selector

Returns:

bool

layout

()

获取 Suggest 外观的 选择器

Returns:

selector

on

(
  • _evtName
  • _cb
)

使用 jquery on 绑定事件

Parameters:

Returns:

SuggestInstance

selector

()

获取 显示 Suggest 的触发源选择器, 比如 a 标签

Returns:

selector

show

()

显示 Suggest

Returns:

SuggestInstance

trigger

(
  • _evtName
)

使用 jquery trigger 绑定事件

Parameters:

Returns:

SuggestInstance

Properties

_allIns

Array private static

保存所有初始化过的实例

Default: []

autoInit

Bool static

设置 Suggest 是否需要自动初始化

Default: true

dataFilter

Function static

数据过滤回调

Default: undefined

layoutTpl

String static

自定义列表显示模板

Default: empty

layoutTpl

String static

Suggest 返回列表的内容是否只使用

Default: empty

Events

SuggestBeforeShow

显示前的事件

SuggestInited

初始化完后的事件

SuggestShow

显示后的事件

SuggestUpdate

获得新数据的事件

SuggestUpdated

数据更新完毕后的事件