公共工具API

frappe.get_route

frappe.get_route()

将当前路由以数组形式返回。

frappe.get_route()
// ["List", "Task", "List"]

frappe.set_route

frappe.set_route(route)

将当前路由更改为 route。

// route in parts
frappe.set_route('List', 'Task', 'List')

// route as array
frappe.set_route(['List', 'Task', 'Gantt'])

// route as string
frappe.set_route('List/Event/Calendar')

// route with options
frappe.set_route(['List', 'Task', 'Task'], { status: 'Open' })

frappe.format

frappe.format(value, df, options, doc)

将原始值格式化为用户可读的展示格式。

frappe.format('2019-09-08', { fieldtype: 'Date' })
// "09-08-2019"

frappe.format('2399', { fieldtype: 'Currency', options: 'currency' }, { inline: true })
// "2,399.00"

frappe.provide

frappe.provide(namespace)

如果 window 对象上不存在该命名空间，则创建并挂载到 window 对象上。

frappe.provide('frappe.ui.form');

// has the same effect as
window.frappe = {}
window.frappe.ui = {}
window.frappe.ui.form = {}

frappe.require

frappe.require(asset_path, callback)

异步加载 JS 或 CSS 资源。用于加载不常用的库。

// load a single asset
frappe.require('/assets/frappe/chat.js', () => {
 // chat.js is loaded
})

// load multiple assets
frappe.require(['/assets/frappe/chat.js', '/assets/frappe/chat.css'], () => {
 // chat.js and chat.css are loaded
})