mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2026-01-30 13:37:35 +00:00
1abd6ee8d6
* [semantic-ui-form] Update to 2.2.11. * [semantic-ui-form] Add previously undocumented 'add prompt' behavior. * [semantic-ui-modal] Fix spacing in documentation. * [semantic-ui-sticky] Update to 2.2.11. * [semantic-ui-popup] Update to 2.2.11. * [semantic-ui-api] Add 'api' setting. * [semantic-ui-api] Lint.
556 lines
18 KiB
TypeScript
556 lines
18 KiB
TypeScript
interface JQueryStatic {
|
|
api: SemanticUI.Api;
|
|
}
|
|
|
|
interface JQuery {
|
|
api: SemanticUI.Api;
|
|
}
|
|
|
|
declare namespace SemanticUI {
|
|
interface Api {
|
|
settings: ApiSettings;
|
|
|
|
/**
|
|
* Execute query using existing API settings
|
|
*/
|
|
(behavior: 'query'): JQuery;
|
|
/**
|
|
* Adds data to existing templated url and returns full url string
|
|
*/
|
|
(behavior: 'add url data', url: string, data: any): string;
|
|
/**
|
|
* Gets promise for current API request
|
|
*/
|
|
(behavior: 'get request'): JQueryDeferred<any> | false;
|
|
/**
|
|
* Aborts current API request
|
|
*/
|
|
(behavior: 'abort'): JQuery;
|
|
/**
|
|
* Removes loading and error state from element
|
|
*/
|
|
(behavior: 'reset'): JQuery;
|
|
/**
|
|
* Returns whether last request was cancelled
|
|
*/
|
|
(behavior: 'was cancelled'): boolean;
|
|
/**
|
|
* Returns whether last request was failure
|
|
*/
|
|
(behavior: 'was failure'): boolean;
|
|
/**
|
|
* Returns whether last request was successful
|
|
*/
|
|
(behavior: 'was successful'): boolean;
|
|
/**
|
|
* Returns whether last request was completed
|
|
*/
|
|
(behavior: 'was complete'): boolean;
|
|
/**
|
|
* Returns whether element is disabled
|
|
*/
|
|
(behavior: 'is disabled'): boolean;
|
|
/**
|
|
* Returns whether element response is mocked
|
|
*/
|
|
(behavior: 'is mocked'): boolean;
|
|
/**
|
|
* Returns whether element is loading
|
|
*/
|
|
(behavior: 'is loading'): boolean;
|
|
/**
|
|
* Sets loading state to element
|
|
*/
|
|
(behavior: 'set loading'): JQuery;
|
|
/**
|
|
* Sets error state to element
|
|
*/
|
|
(behavior: 'set error'): JQuery;
|
|
/**
|
|
* Removes loading state to element
|
|
*/
|
|
(behavior: 'remove loading'): JQuery;
|
|
/**
|
|
* Removes error state to element
|
|
*/
|
|
(behavior: 'remove error'): JQuery;
|
|
/**
|
|
* Gets event that API request will occur on
|
|
*/
|
|
(behavior: 'get event'): string;
|
|
/**
|
|
* Returns encodeURIComponent value only if value passed is not already encoded
|
|
*/
|
|
(behavior: 'get url encoded value', value: any): string;
|
|
/**
|
|
* Reads a locally cached response for a URL
|
|
*/
|
|
(behavior: 'read cached response', url: string): any;
|
|
/**
|
|
* Writes a cached response for a URL
|
|
*/
|
|
(behavior: 'write cached response', url: string, response: any): JQuery;
|
|
/**
|
|
* Creates new cache, removing all locally cached URLs
|
|
*/
|
|
(behavior: 'create cache'): JQuery;
|
|
/**
|
|
* Removes API settings from the page and all events
|
|
*/
|
|
(behavior: 'destroy'): JQuery;
|
|
<K extends keyof ApiSettings>(behavior: 'setting', name: K, value?: undefined): ApiSettings._Impl[K];
|
|
<K extends keyof ApiSettings>(behavior: 'setting', name: K, value: ApiSettings._Impl[K]): JQuery;
|
|
(behavior: 'setting', value: ApiSettings): JQuery;
|
|
(settings?: ApiSettings): JQuery;
|
|
}
|
|
|
|
/**
|
|
* @see {@link http://semantic-ui.com/behaviors/api.html#/settings}
|
|
*/
|
|
type ApiSettings = ApiSettings.Param;
|
|
|
|
namespace ApiSettings {
|
|
type Param = (Pick<_Impl, 'api'> |
|
|
Pick<_Impl, 'on'> |
|
|
Pick<_Impl, 'cache'> |
|
|
Pick<_Impl, 'stateContext'> |
|
|
Pick<_Impl, 'encodeParameters'> |
|
|
Pick<_Impl, 'defaultData'> |
|
|
Pick<_Impl, 'serializeForm'> |
|
|
Pick<_Impl, 'throttle'> |
|
|
Pick<_Impl, 'throttleFirstRequest'> |
|
|
Pick<_Impl, 'interruptRequests'> |
|
|
Pick<_Impl, 'loadingDuration'> |
|
|
Pick<_Impl, 'hideError'> |
|
|
Pick<_Impl, 'errorDuration'> |
|
|
Pick<_Impl, 'action'> |
|
|
Pick<_Impl, 'url'> |
|
|
Pick<_Impl, 'urlData'> |
|
|
Pick<_Impl, 'response'> |
|
|
Pick<_Impl, 'responseAsync'> |
|
|
Pick<_Impl, 'mockResponse'> |
|
|
Pick<_Impl, 'mockResponseAsync'> |
|
|
Pick<_Impl, 'method'> |
|
|
Pick<_Impl, 'dataType'> |
|
|
Pick<_Impl, 'data'> |
|
|
Pick<_Impl, 'beforeSend'> |
|
|
Pick<_Impl, 'beforeXHR'> |
|
|
Pick<_Impl, 'onRequest'> |
|
|
Pick<_Impl, 'onResponse'> |
|
|
Pick<_Impl, 'successTest'> |
|
|
Pick<_Impl, 'onSuccess'> |
|
|
Pick<_Impl, 'onComplete'> |
|
|
Pick<_Impl, 'onFailure'> |
|
|
Pick<_Impl, 'onError'> |
|
|
Pick<_Impl, 'onAbort'> |
|
|
Pick<_Impl, 'regExp'> |
|
|
Pick<_Impl, 'selector'> |
|
|
Pick<_Impl, 'className'> |
|
|
Pick<_Impl, 'metadata'> |
|
|
Pick<_Impl, 'error'> |
|
|
Pick<_Impl, 'namespace'> |
|
|
Pick<_Impl, 'name'> |
|
|
Pick<_Impl, 'silent'> |
|
|
Pick<_Impl, 'debug'> |
|
|
Pick<_Impl, 'performance'> |
|
|
Pick<_Impl, 'verbose'>) &
|
|
Partial<Pick<_Impl, keyof _Impl>>;
|
|
|
|
interface _Impl {
|
|
api: {
|
|
[action: string]: string;
|
|
};
|
|
|
|
// region Behavior
|
|
|
|
/**
|
|
* When API event should occur
|
|
*
|
|
* @default 'auto'
|
|
*/
|
|
on: string;
|
|
/**
|
|
* Can be set to 'local' to cache successful returned AJAX responses when using a JSON API.
|
|
* This helps avoid server round trips when API endpoints will return the same results when accessed repeatedly.
|
|
* Setting to false, will add cache busting parameters to the URL.
|
|
*
|
|
* @default true
|
|
*/
|
|
cache: 'local' | boolean;
|
|
/**
|
|
* UI state will be applied to this element, defaults to triggering element.
|
|
*/
|
|
stateContext: string | JQuery;
|
|
/**
|
|
* Whether to encode parameters with encodeURIComponent before adding into url string
|
|
*
|
|
* @default true
|
|
*/
|
|
encodeParameters: boolean;
|
|
/**
|
|
* Whether to automatically include default data like {value} and {text}
|
|
*
|
|
* @default true
|
|
*/
|
|
defaultData: boolean;
|
|
/**
|
|
* Whether to serialize closest form and include in request
|
|
*
|
|
* @default false
|
|
*/
|
|
serializeForm: boolean;
|
|
/**
|
|
* How long to wait when a request is made before triggering request, useful for rate limiting oninput
|
|
*
|
|
* @default 0
|
|
*/
|
|
throttle: number;
|
|
/**
|
|
* When set to false will not delay the first request made, when no others are queued
|
|
*
|
|
* @default true
|
|
*/
|
|
throttleFirstRequest: boolean;
|
|
/**
|
|
* Whether an API request can occur while another request is still pending
|
|
*
|
|
* @default false
|
|
*/
|
|
interruptRequests: boolean;
|
|
/**
|
|
* Minimum duration to show loading indication
|
|
*
|
|
* @default 0
|
|
*/
|
|
loadingDuration: number;
|
|
/**
|
|
* The default auto will automatically remove error state after error duration, unless the element is a form
|
|
*
|
|
* @default 'auto'
|
|
*/
|
|
hideError: 'auto' | boolean;
|
|
/**
|
|
* Setting to true, will not remove error.
|
|
* Setting to a duration in milliseconds to show error state after request error.
|
|
*
|
|
* @default 2000
|
|
*/
|
|
errorDuration: true | number;
|
|
|
|
// endregion
|
|
|
|
// region Request Settings
|
|
|
|
/**
|
|
* Named API action for query, originally specified in $.fn.settings.api
|
|
*/
|
|
action: string | false;
|
|
/**
|
|
* Templated URL for query, will override specified action
|
|
*/
|
|
url: string | false;
|
|
/**
|
|
* Variables to use for replacement
|
|
*/
|
|
urlData: any | false;
|
|
/**
|
|
* Can be set to a Javascript object which will be returned automatically instead of requesting JSON from server
|
|
*/
|
|
response: any | false;
|
|
/**
|
|
* When specified, this function can be used to retrieve content from a server and return it asynchronously instead of a standard AJAX call.
|
|
* The callback function should return the server response.
|
|
*
|
|
* @default false
|
|
*/
|
|
responseAsync: ((settings: ApiSettings, callback: (response: any) => void) => void) | false;
|
|
/**
|
|
* @see response
|
|
*/
|
|
mockResponse: any | false;
|
|
/**
|
|
* @see responseAsync
|
|
*/
|
|
mockResponseAsync: ((settings: ApiSettings, callback: (response: any) => void) => void) | false;
|
|
/**
|
|
* Method for transmitting request to server
|
|
*/
|
|
method: 'post' | 'get' | 'put' | 'delete' | 'head' | 'options' | 'patch';
|
|
/**
|
|
* Expected data type of response
|
|
*/
|
|
dataType: 'xml' | 'json' | 'jsonp' | 'script' | 'html' | 'text';
|
|
/**
|
|
* POST/GET Data to Send with Request
|
|
*/
|
|
data: any;
|
|
|
|
// endregion
|
|
|
|
// region Callbacks
|
|
|
|
/**
|
|
* Allows modifying settings before request, or cancelling request
|
|
*/
|
|
beforeSend(settings: ApiSettings): any;
|
|
/**
|
|
* Allows modifying XHR object for request
|
|
*/
|
|
beforeXHR(xhrObject: JQuery.jqXHR): any;
|
|
/**
|
|
* Callback that occurs when request is made. Receives both the API success promise and the XHR request promise.
|
|
*/
|
|
onRequest(promise: JQuery.Deferred<any>, xhr: JQuery.jqXHR): void;
|
|
/**
|
|
* Allows modifying the server's response before parsed by other callbacks to determine API event success
|
|
*/
|
|
onResponse(response: any): void;
|
|
/**
|
|
* Determines whether completed JSON response should be treated as successful
|
|
*
|
|
* @see {@link http://semantic-ui.com/behaviors/api.html#determining-json-success}
|
|
*/
|
|
successTest(response: any): boolean;
|
|
/**
|
|
* Callback after successful response, JSON response must pass successTest
|
|
*/
|
|
onSuccess(response: any, element: JQuery, xhr: JQuery.jqXHR): void;
|
|
/**
|
|
* Callback on request complete regardless of conditions
|
|
*/
|
|
onComplete(response: any, element: JQuery, xhr: JQuery.jqXHR): void;
|
|
/**
|
|
* Callback on failed response, or JSON response that fails successTest
|
|
*/
|
|
onFailure(response: any, element: JQuery): void;
|
|
/**
|
|
* Callback on server error from returned status code, or XHR failure.
|
|
*/
|
|
onError(errorMessage: string, element: JQuery, xhr: JQuery.jqXHR): void;
|
|
/**
|
|
* Callback on abort caused by user clicking a link or manually cancelling request.
|
|
*/
|
|
onAbort(errorMessage: string, element: JQuery, xhr: JQuery.jqXHR): void;
|
|
|
|
// endregion
|
|
|
|
// region DOM Settings
|
|
|
|
/**
|
|
* Regular expressions used for template matching
|
|
*/
|
|
regExp: Api.RegExpSettings;
|
|
/**
|
|
* Selectors used to find parts of a module
|
|
*/
|
|
selector: Api.SelectorSettings;
|
|
/**
|
|
* Class names used to determine element state
|
|
*/
|
|
className: Api.ClassNameSettings;
|
|
/**
|
|
* Metadata used to store XHR and response promise
|
|
*/
|
|
metadata: Api.MetadataSettings;
|
|
|
|
// endregion
|
|
|
|
// region Debug Settings
|
|
|
|
error: Api.ErrorSettings;
|
|
|
|
// endregion
|
|
|
|
// region Component Settings
|
|
|
|
// region DOM Settings
|
|
|
|
/**
|
|
* Event namespace. Makes sure module teardown does not effect other events attached to an element.
|
|
*/
|
|
namespace: string;
|
|
|
|
// endregion
|
|
|
|
// region Debug Settings
|
|
|
|
/**
|
|
* Name used in log statements
|
|
*/
|
|
name: string;
|
|
/**
|
|
* Silences all console output including error messages, regardless of other debug settings.
|
|
*/
|
|
silent: boolean;
|
|
/**
|
|
* Debug output to console
|
|
*/
|
|
debug: boolean;
|
|
/**
|
|
* Show console.table output with performance metrics
|
|
*/
|
|
performance: boolean;
|
|
/**
|
|
* Debug output includes all internal behaviors
|
|
*/
|
|
verbose: boolean;
|
|
|
|
// endregion
|
|
|
|
// endregion
|
|
}
|
|
}
|
|
|
|
namespace Api {
|
|
type RegExpSettings = RegExpSettings.Param;
|
|
|
|
namespace RegExpSettings {
|
|
type Param = (Pick<_Impl, 'required'> |
|
|
Pick<_Impl, 'optional'>) &
|
|
Partial<Pick<_Impl, keyof _Impl>>;
|
|
|
|
interface _Impl {
|
|
/**
|
|
* @default /\{\$*[A-z0-9]+\}/g
|
|
*/
|
|
required: RegExp;
|
|
/**
|
|
* @default /\{\/\$*[A-z0-9]+\}/g
|
|
*/
|
|
optional: RegExp;
|
|
}
|
|
}
|
|
|
|
type SelectorSettings = SelectorSettings.Param;
|
|
|
|
namespace SelectorSettings {
|
|
type Param = (Pick<_Impl, 'disabled'> |
|
|
Pick<_Impl, 'form'>) &
|
|
Partial<Pick<_Impl, keyof _Impl>>;
|
|
|
|
interface _Impl {
|
|
/**
|
|
* @default '.disabled'
|
|
*/
|
|
disabled: string;
|
|
/**
|
|
* @default 'form'
|
|
*/
|
|
form: string;
|
|
}
|
|
}
|
|
|
|
type ClassNameSettings = ClassNameSettings.Param;
|
|
|
|
namespace ClassNameSettings {
|
|
type Param = (Pick<_Impl, 'loading'> |
|
|
Pick<_Impl, 'error'>) &
|
|
Partial<Pick<_Impl, keyof _Impl>>;
|
|
|
|
interface _Impl {
|
|
/**
|
|
* @default 'loading'
|
|
*/
|
|
loading: string;
|
|
/**
|
|
* @default 'error'
|
|
*/
|
|
error: string;
|
|
}
|
|
}
|
|
|
|
type MetadataSettings = MetadataSettings.Param;
|
|
|
|
namespace MetadataSettings {
|
|
type Param = (Pick<_Impl, 'action'> |
|
|
Pick<_Impl, 'url'>) &
|
|
Partial<Pick<_Impl, keyof _Impl>>;
|
|
|
|
interface _Impl {
|
|
/**
|
|
* @default 'action'
|
|
*/
|
|
action: string;
|
|
/**
|
|
* @default 'url'
|
|
*/
|
|
url: string;
|
|
}
|
|
}
|
|
|
|
type ErrorSettings = ErrorSettings.Param;
|
|
|
|
namespace ErrorSettings {
|
|
type Param = (Pick<_Impl, 'beforeSend'> |
|
|
Pick<_Impl, 'error'> |
|
|
Pick<_Impl, 'exitConditions'> |
|
|
Pick<_Impl, 'JSONParse'> |
|
|
Pick<_Impl, 'legacyParameters'> |
|
|
Pick<_Impl, 'missingAction'> |
|
|
Pick<_Impl, 'missingSerialize'> |
|
|
Pick<_Impl, 'missingURL'> |
|
|
Pick<_Impl, 'noReturnedValue'> |
|
|
Pick<_Impl, 'parseError'> |
|
|
Pick<_Impl, 'requiredParameter'> |
|
|
Pick<_Impl, 'statusMessage'> |
|
|
Pick<_Impl, 'timeout'>) &
|
|
Partial<Pick<_Impl, keyof _Impl>>;
|
|
|
|
interface _Impl {
|
|
/**
|
|
* @default 'The before send function has aborted the request'
|
|
*/
|
|
beforeSend: string;
|
|
/**
|
|
* @default 'There was an error with your request'
|
|
*/
|
|
error: string;
|
|
/**
|
|
* @default 'API Request Aborted. Exit conditions met'
|
|
*/
|
|
exitConditions: string;
|
|
/**
|
|
* @default 'JSON could not be parsed during error handling'
|
|
*/
|
|
JSONParse: string;
|
|
/**
|
|
* @default 'You are using legacy API success callback names'
|
|
*/
|
|
legacyParameters: string;
|
|
/**
|
|
* @default 'API action used but no url was defined'
|
|
*/
|
|
missingAction: string;
|
|
/**
|
|
* @default 'Required dependency jquery-serialize-object missing, using basic serialize'
|
|
*/
|
|
missingSerialize: string;
|
|
/**
|
|
* @default 'No URL specified for API event'
|
|
*/
|
|
missingURL: string;
|
|
/**
|
|
* @default 'The beforeSend callback must return a settings object, beforeSend ignored.'
|
|
*/
|
|
noReturnedValue: string;
|
|
/**
|
|
* @default 'There was an error parsing your request'
|
|
*/
|
|
parseError: string;
|
|
/**
|
|
* @default 'Missing a required URL parameter: '
|
|
*/
|
|
requiredParameter: string;
|
|
/**
|
|
* @default 'Server gave an error: '
|
|
*/
|
|
statusMessage: string;
|
|
/**
|
|
* @default 'Your request timed out'
|
|
*/
|
|
timeout: string;
|
|
}
|
|
}
|
|
}
|
|
}
|