github/svgedit
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

- Build: Update with recent jsdoc changes

Browse Source 
- npm: Update devDeps
This commit is contained in:
Brett Zamir
2020-05-07 10:14:01 +08:00
parent 171e1ce856
commit f46f5fc889
6 changed files with 110 additions and 74 deletions
Download Patch File Download Diff File Expand all files Collapse all files

64
dist/index-es.js vendored
View File

@@ -29089,6 +29089,7 @@ function getImportLocale(_ref) {
/**
* Store and retrieve preferences.
* @function module:SVGEditor.pref
* @param {string} key The preference name to be retrieved or set
* @param {string} [val] The value. If the value supplied is missing or falsey, no change to the preference will
* be made unless `mayBeEmpty` is set.
@@ -29135,6 +29136,7 @@ editor.setStrings = setStrings;
* storage. This will override URL settings (for security reasons) but
* not `svgedit-config-iife.js` configuration (unless initial user
* overriding is explicitly permitted there via `allowInitialUserOverride`).
* @function module:SVGEditor.loadContentAndPrefs
* @todo Split `allowInitialUserOverride` into `allowOverrideByURL` and
* `allowOverrideByUserStorage` so `svgedit-config-iife.js` can disallow some
* individual items for URL setting but allow for user storage AND/OR
@@ -29181,6 +29183,7 @@ editor.loadContentAndPrefs = function () {
};
/**
* Allows setting of preferences or configuration (including extensions).
* @function module:SVGEditor.setConfig
* @param {module:SVGEditor.Config|module:SVGEditor.Prefs} opts The preferences or configuration (including extensions). See the tutorial on {@tutorial ConfigOptions} for info on config and preferences.
* @param {PlainObject} [cfgCfg] Describes configuration which applies to the
* particular batch of supplied options
@@ -29325,6 +29328,7 @@ editor.setConfig = function (opts, cfgCfg) {
/**
* Allows one to override default SVGEdit `open`, `save`, and
* `export` editor behaviors.
* @function module:SVGEditor.setCustomHandlers
* @param {module:SVGEditor.CustomHandler} opts Extension mechanisms may call `setCustomHandlers` with three functions: `opts.open`, `opts.save`, and `opts.exportImage`
* @returns {Promise<void>}
*/
@@ -29355,9 +29359,10 @@ editor.setCustomHandlers = function (opts) {
});
};
/**
* @param {boolean} arg
* @returns {void}
*/
* @function module:SVGEditor.randomizeIds
* @param {boolean} arg
* @returns {void}
*/
editor.randomizeIds = function (arg) {
@@ -29365,6 +29370,7 @@ editor.randomizeIds = function (arg) {
};
/**
* Auto-run after a Promise microtask.
* @function module:SVGEditor.init
* @returns {void}
*/
@@ -29530,6 +29536,7 @@ editor.init = function () {
setupCurPrefs();
/**
* Called internally.
* @function module:SVGEditor.setIcon
* @param {string|Element|external:jQuery} elem
* @param {string|external:jQuery} iconId
* @param {Float} forcedSize Not in use
@@ -29800,6 +29807,7 @@ editor.init = function () {
};
/**
* Called internally.
* @function module:SVGEditor.setIconSize
* @param {module:SVGEditor.IconSize} size
* @returns {void}
*/
@@ -30658,7 +30666,7 @@ editor.init = function () {
* - Removes the `tool_button_current` class from whatever tool currently has it.
* - Hides any flyouts.
* - Adds the `tool_button_current` class to the button passed in.
* @function module:SVGEDitor.toolButtonClick
* @function module:SVGEditor.toolButtonClick
* @param {string|Element} button The DOM element or string selector representing the toolbar button
* @param {boolean} noHiding Whether not to hide any flyouts
* @returns {boolean} Whether the button was disabled or not
@@ -32929,9 +32937,10 @@ editor.init = function () {
}
});
/**
* @param {boolean} active
* @returns {void}
*/
* @function module:SVGEditor.setPanning
* @param {boolean} active
* @returns {void}
*/
editor.setPanning = function (active) {
svgCanvas.spaceKey = keypan = active;
@@ -33028,6 +33037,7 @@ editor.init = function () {
*/
/**
* @function module:SVGEditor.addDropDown
* @param {Element|string} elem DOM Element or selector
* @param {module:SVGEditor.DropDownCallback} callback Mouseup callback
* @param {boolean} dropUp
@@ -35923,9 +35933,10 @@ editor.init = function () {
return uiStrings$1;
};
/**
* @returns {Promise<boolean>} Resolves to boolean indicating `true` if there were no changes
* and `false` after the user confirms.
*/
* @function module:SVGEditor.openPrep
* @returns {boolean|Promise<boolean>} Resolves to boolean indicating `true` if there were no changes
* and `false` after the user confirms.
*/
editor.openPrep = function () {
@@ -36335,6 +36346,7 @@ editor.init = function () {
* Queues a callback to be invoked when the editor is ready (or
* to be invoked immediately if it is already ready--i.e.,
* if `runCallbacks` has been run).
* @function module:SVGEditor.ready
* @param {module:SVGEditor.ReadyCallback} cb Callback to be queued to invoke
* @returns {Promise<ArbitraryCallbackResult>} Resolves when all callbacks, including the supplied have resolved
*/
@@ -36355,6 +36367,7 @@ editor.ready = function (cb) {
};
/**
* Invokes the callbacks previous set by `svgEditor.ready`
* @function module:SVGEditor.runCallbacks
* @returns {Promise<void>} Resolves to `undefined` if all callbacks succeeded and rejects otherwise
*/
@@ -36405,11 +36418,12 @@ editor.runCallbacks = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/regeneratorRu
}, _callee20, null, [[0, 5]]);
}));
/**
* @param {string} str The SVG string to load
* @param {PlainObject} [opts={}]
* @param {boolean} [opts.noAlert=false] Option to avoid alert to user and instead get rejected promise
* @returns {Promise<void>}
*/
* @function module:SVGEditor.loadFromString
* @param {string} str The SVG string to load
* @param {PlainObject} [opts={}]
* @param {boolean} [opts.noAlert=false] Option to avoid alert to user and instead get rejected promise
* @returns {Promise<void>}
*/
editor.loadFromString = function (str) {
var _ref36 = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {},
@@ -36451,6 +36465,7 @@ editor.loadFromString = function (str) {
};
/**
* Not presently in use.
* @function module:SVGEditor.disableUI
* @param {PlainObject} featList
* @returns {void}
*/
@@ -36468,14 +36483,15 @@ editor.disableUI = function (featList) {// $(function () {
*/
/**
* @param {string} url URL from which to load an SVG string via Ajax
* @param {PlainObject} [opts={}] May contain properties: `cache`, `callback`
* @param {boolean} [opts.cache]
* @param {boolean} [opts.noAlert]
* @returns {Promise<void>} Resolves to `undefined` or rejects upon bad loading of
* the SVG (or upon failure to parse the loaded string) when `noAlert` is
* enabled
*/
* @function module:SVGEditor.loadFromURL
* @param {string} url URL from which to load an SVG string via Ajax
* @param {PlainObject} [opts={}] May contain properties: `cache`, `callback`
* @param {boolean} [opts.cache]
* @param {boolean} [opts.noAlert]
* @returns {Promise<void>} Resolves to `undefined` or rejects upon bad loading of
* the SVG (or upon failure to parse the loaded string) when `noAlert` is
* enabled
*/
editor.loadFromURL = function (url) {
@@ -36522,6 +36538,7 @@ editor.loadFromURL = function (url) {
});
};
/**
* @function module:SVGEditor.loadFromDataURI
* @param {string} str The Data URI to base64-decode (if relevant) and load
* @param {PlainObject} [opts={}]
* @param {boolean} [opts.noAlert]
@@ -36554,6 +36571,7 @@ editor.loadFromDataURI = function (str) {
});
};
/**
* @function module:SVGEditor.addExtension
* @param {string} name Used internally; no need for i18n.
* @param {module:svgcanvas.ExtensionInitCallback} init Config to be invoked on this module
* @param {module:svgcanvas.ExtensionInitArgs} initArgs

2
dist/index-es.min.js.map vendored
View File

File diff suppressed because one or more lines are too long

64
dist/index-umd.js vendored
View File

@@ -29095,6 +29095,7 @@
/**
* Store and retrieve preferences.
* @function module:SVGEditor.pref
* @param {string} key The preference name to be retrieved or set
* @param {string} [val] The value. If the value supplied is missing or falsey, no change to the preference will
* be made unless `mayBeEmpty` is set.
@@ -29141,6 +29142,7 @@
* storage. This will override URL settings (for security reasons) but
* not `svgedit-config-iife.js` configuration (unless initial user
* overriding is explicitly permitted there via `allowInitialUserOverride`).
* @function module:SVGEditor.loadContentAndPrefs
* @todo Split `allowInitialUserOverride` into `allowOverrideByURL` and
* `allowOverrideByUserStorage` so `svgedit-config-iife.js` can disallow some
* individual items for URL setting but allow for user storage AND/OR
@@ -29187,6 +29189,7 @@
};
/**
* Allows setting of preferences or configuration (including extensions).
* @function module:SVGEditor.setConfig
* @param {module:SVGEditor.Config|module:SVGEditor.Prefs} opts The preferences or configuration (including extensions). See the tutorial on {@tutorial ConfigOptions} for info on config and preferences.
* @param {PlainObject} [cfgCfg] Describes configuration which applies to the
* particular batch of supplied options
@@ -29331,6 +29334,7 @@
/**
* Allows one to override default SVGEdit `open`, `save`, and
* `export` editor behaviors.
* @function module:SVGEditor.setCustomHandlers
* @param {module:SVGEditor.CustomHandler} opts Extension mechanisms may call `setCustomHandlers` with three functions: `opts.open`, `opts.save`, and `opts.exportImage`
* @returns {Promise<void>}
*/
@@ -29361,9 +29365,10 @@
});
};
/**
* @param {boolean} arg
* @returns {void}
*/
* @function module:SVGEditor.randomizeIds
* @param {boolean} arg
* @returns {void}
*/
editor.randomizeIds = function (arg) {
@@ -29371,6 +29376,7 @@
};
/**
* Auto-run after a Promise microtask.
* @function module:SVGEditor.init
* @returns {void}
*/
@@ -29536,6 +29542,7 @@
setupCurPrefs();
/**
* Called internally.
* @function module:SVGEditor.setIcon
* @param {string|Element|external:jQuery} elem
* @param {string|external:jQuery} iconId
* @param {Float} forcedSize Not in use
@@ -29806,6 +29813,7 @@
};
/**
* Called internally.
* @function module:SVGEditor.setIconSize
* @param {module:SVGEditor.IconSize} size
* @returns {void}
*/
@@ -30664,7 +30672,7 @@
* - Removes the `tool_button_current` class from whatever tool currently has it.
* - Hides any flyouts.
* - Adds the `tool_button_current` class to the button passed in.
* @function module:SVGEDitor.toolButtonClick
* @function module:SVGEditor.toolButtonClick
* @param {string|Element} button The DOM element or string selector representing the toolbar button
* @param {boolean} noHiding Whether not to hide any flyouts
* @returns {boolean} Whether the button was disabled or not
@@ -32935,9 +32943,10 @@
}
});
/**
* @param {boolean} active
* @returns {void}
*/
* @function module:SVGEditor.setPanning
* @param {boolean} active
* @returns {void}
*/
editor.setPanning = function (active) {
svgCanvas.spaceKey = keypan = active;
@@ -33034,6 +33043,7 @@
*/
/**
* @function module:SVGEditor.addDropDown
* @param {Element|string} elem DOM Element or selector
* @param {module:SVGEditor.DropDownCallback} callback Mouseup callback
* @param {boolean} dropUp
@@ -35929,9 +35939,10 @@
return uiStrings$1;
};
/**
* @returns {Promise<boolean>} Resolves to boolean indicating `true` if there were no changes
* and `false` after the user confirms.
*/
* @function module:SVGEditor.openPrep
* @returns {boolean|Promise<boolean>} Resolves to boolean indicating `true` if there were no changes
* and `false` after the user confirms.
*/
editor.openPrep = function () {
@@ -36341,6 +36352,7 @@
* Queues a callback to be invoked when the editor is ready (or
* to be invoked immediately if it is already ready--i.e.,
* if `runCallbacks` has been run).
* @function module:SVGEditor.ready
* @param {module:SVGEditor.ReadyCallback} cb Callback to be queued to invoke
* @returns {Promise<ArbitraryCallbackResult>} Resolves when all callbacks, including the supplied have resolved
*/
@@ -36361,6 +36373,7 @@
};
/**
* Invokes the callbacks previous set by `svgEditor.ready`
* @function module:SVGEditor.runCallbacks
* @returns {Promise<void>} Resolves to `undefined` if all callbacks succeeded and rejects otherwise
*/
@@ -36411,11 +36424,12 @@
}, _callee20, null, [[0, 5]]);
}));
/**
* @param {string} str The SVG string to load
* @param {PlainObject} [opts={}]
* @param {boolean} [opts.noAlert=false] Option to avoid alert to user and instead get rejected promise
* @returns {Promise<void>}
*/
* @function module:SVGEditor.loadFromString
* @param {string} str The SVG string to load
* @param {PlainObject} [opts={}]
* @param {boolean} [opts.noAlert=false] Option to avoid alert to user and instead get rejected promise
* @returns {Promise<void>}
*/
editor.loadFromString = function (str) {
var _ref36 = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {},
@@ -36457,6 +36471,7 @@
};
/**
* Not presently in use.
* @function module:SVGEditor.disableUI
* @param {PlainObject} featList
* @returns {void}
*/
@@ -36474,14 +36489,15 @@
*/
/**
* @param {string} url URL from which to load an SVG string via Ajax
* @param {PlainObject} [opts={}] May contain properties: `cache`, `callback`
* @param {boolean} [opts.cache]
* @param {boolean} [opts.noAlert]
* @returns {Promise<void>} Resolves to `undefined` or rejects upon bad loading of
* the SVG (or upon failure to parse the loaded string) when `noAlert` is
* enabled
*/
* @function module:SVGEditor.loadFromURL
* @param {string} url URL from which to load an SVG string via Ajax
* @param {PlainObject} [opts={}] May contain properties: `cache`, `callback`
* @param {boolean} [opts.cache]
* @param {boolean} [opts.noAlert]
* @returns {Promise<void>} Resolves to `undefined` or rejects upon bad loading of
* the SVG (or upon failure to parse the loaded string) when `noAlert` is
* enabled
*/
editor.loadFromURL = function (url) {
@@ -36528,6 +36544,7 @@
});
};
/**
* @function module:SVGEditor.loadFromDataURI
* @param {string} str The Data URI to base64-decode (if relevant) and load
* @param {PlainObject} [opts={}]
* @param {boolean} [opts.noAlert]
@@ -36560,6 +36577,7 @@
});
};
/**
* @function module:SVGEditor.addExtension
* @param {string} name Used internally; no need for i18n.
* @param {module:svgcanvas.ExtensionInitCallback} init Config to be invoked on this module
* @param {module:svgcanvas.ExtensionInitArgs} initArgs

2
dist/index-umd.min.js.map vendored
View File

File diff suppressed because one or more lines are too long