@types/uikit
Advanced tools
Comparing version 2.27.7 to 3.3.0
1877
uikit/index.d.ts
@@ -1,1441 +0,582 @@ | ||
// Type definitions for uikit 2.27 | ||
// Type definitions for uikit 3.3 | ||
// Project: https://getuikit.com | ||
// Definitions by: Giovanni Silva <https://github.com/giovannicandido>, Ivo Senner <https://github.com/s0x> | ||
// Definitions by: Giovanni Silva <https://github.com/giovannicandido> | ||
// Ivo Senner <https://github.com/s0x> | ||
// Weiyu Weng <https://github.com/pcdotfan> | ||
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped | ||
// TypeScript Version: 2.3 | ||
/// <reference types="jquery" /> | ||
type UIkitElement = object | HTMLElement | string; | ||
type UIkitNodes = NodeList | HTMLCollection | UIkitNode; | ||
type UIkitNode = Node; | ||
declare namespace UIkit { | ||
interface DropdownElement { | ||
/** | ||
* Show the dropdown | ||
*/ | ||
export namespace UIkit { | ||
const util: object; | ||
const component: object; | ||
const data: string; | ||
const prefix: string; | ||
const options: object; | ||
const version: string; | ||
const use: object; | ||
const mixin: object; | ||
const extend: object; | ||
const update: object; | ||
interface UIkitAccordionOptions { | ||
active?: number; | ||
animation?: boolean; | ||
collapsible?: boolean; | ||
content?: string; | ||
duration?: number; | ||
multiple?: boolean; | ||
targets?: string; | ||
toggle?: string; | ||
transition?: string; | ||
} | ||
interface UIkitAccordionElement { | ||
toggle(index: string | number | UIkitNode, animate: boolean): void; | ||
} | ||
type Accordion = (element: UIkitElement, options?: UIkitAccordionOptions) => UIkitAccordionElement; | ||
interface UIkitAlertOptions { | ||
animation?: boolean | string; | ||
duration?: number; | ||
'sel-close'?: string; | ||
} | ||
interface UIkitAlertElement { | ||
close(): void; | ||
} | ||
type Alert = (element: UIkitElement, options?: UIkitAlertOptions) => UIkitAlertElement; | ||
interface UIkitCoverOptions { | ||
automute?: boolean; | ||
width?: number; | ||
height?: number; | ||
} | ||
type Cover = (element: UIkitElement, options?: UIkitCoverOptions) => void; | ||
interface UIkitDropOptions { | ||
toggle?: string | boolean; | ||
pos?: string; | ||
mode?: string; | ||
'delay-show'?: number; | ||
'delay-hide'?: number; | ||
boundary?: string; | ||
'boundary-align'?: boolean; | ||
flip?: boolean | string; | ||
offset?: number; | ||
animation?: string; | ||
duration?: number; | ||
} | ||
interface UIkitDropElement { | ||
show(): void; | ||
/** | ||
* Hide the dropdown | ||
*/ | ||
hide(force?: boolean): void; | ||
hide(): void; | ||
} | ||
type DropdownPosition = | ||
'bottom-left' | | ||
'bottom-center' | | ||
'bottom-right' | | ||
'top-left' | | ||
'top-center' | | ||
'top-right' | | ||
'left-top' | | ||
'left-center' | | ||
'left-bottom' | | ||
'right-top' | | ||
'right-center' | | ||
'right-bottom'; | ||
interface DropdownOptions { | ||
/** | ||
* Dropdown position | ||
* @default 'bottom-left' | ||
*/ | ||
pos?: DropdownPosition; | ||
/** | ||
* Dropdown trigger behaviour | ||
* @default 'hover' | ||
*/ | ||
mode?: 'hover'|'click'; | ||
/** | ||
* Remain time before auto closing dropdown in hover mode | ||
* @default 800 | ||
*/ | ||
remaintime?: number; | ||
/** | ||
* Stretch dropdown width to a specified element | ||
* @default false | ||
*/ | ||
justify?: string|JQuery|false; | ||
/** | ||
* Referenced element to keep dropdowns visibilty | ||
* @default window | ||
*/ | ||
boundary?: string|JQuery|Window; | ||
/** | ||
* Delay time in hover mode before a dropdown is shown in ms | ||
* @default 0 | ||
*/ | ||
delay?: number; | ||
/** | ||
* Dropdown selector | ||
* @default '.uk-dropdown,.uk-dropdown-blank' | ||
*/ | ||
dropdownSelector?: string|JQuery; | ||
/** | ||
* Is added to the delay time when hovering from one active dropdown to another dropdown (in ms) | ||
* @default 250 | ||
*/ | ||
hoverDelayIdle?: number; | ||
/** | ||
* Prevent automatic dropdown flip | ||
* Possible values: 'x', 'y', true, false | ||
* @default false | ||
*/ | ||
preventflip?: 'x'|'y'|boolean; | ||
type Drop = (element: UIkitElement, options?: UIkitDropOptions) => UIkitDropElement; | ||
interface UIkitDropdownOptions { | ||
toggle?: string | boolean; | ||
pos?: string; | ||
mode?: string; | ||
'delay-show'?: number; | ||
'delay-hide'?: number; | ||
boundary?: string; | ||
'boundary-align'?: boolean; | ||
flip?: boolean | string; | ||
offset?: number; | ||
animation?: string; | ||
duration?: number; | ||
} | ||
/** | ||
* Create a toggleable dropdown with different styles | ||
* Documentation: {@link http://getuikit.org/docs/dropdown.html} | ||
* | ||
* Events: | ||
* Name Description | ||
* show.uk.dropdown Triggered on dropdown show | ||
* hide.uk.dropdown Triggered on dropdown hide | ||
* stack.uk.dropdown Triggered when a dropdown stacks to fit into screen | ||
*/ | ||
type Dropdown = (selector: string|JQuery, options?: DropdownOptions) => DropdownElement; | ||
interface ModalElement { | ||
/** | ||
* Show the modal | ||
*/ | ||
interface UIkitDropdownElement { | ||
show(): void; | ||
/** | ||
* Hide the modal | ||
*/ | ||
hide(): void; | ||
/** | ||
* Return if the modal is active on the page | ||
* @return True if the modal is current active on the page, false otherwise | ||
*/ | ||
isActive(): boolean; | ||
} | ||
interface ModalOptions { | ||
/** | ||
* Allows controls from keyboard (ESC to close) | ||
* @default true | ||
* <h2>Possible value</h2> | ||
* boolean | ||
*/ | ||
keyboard?: boolean; | ||
/** | ||
* Allow modal to close automatically when clicking on the modal overlay | ||
* @default true | ||
* <h2>Possible value</h2> | ||
* boolean | ||
*/ | ||
bgclose?: boolean; | ||
/** | ||
* Set the height for overflow container to start scrolling | ||
* @default 150 | ||
* <h2>Possible value</h2> | ||
* integer | ||
*/ | ||
minScrollHeight?: number; | ||
/** | ||
* Vertically center the modal | ||
* @default false | ||
* <h2>Possible value</h2> | ||
* boolean | ||
*/ | ||
center?: boolean; | ||
/** | ||
* Close currently opened modals on opening modal | ||
* @default true | ||
* <h2>Possible value</h2> | ||
* boolean | ||
*/ | ||
modal?: boolean; | ||
type Dropdown = (element: UIkitElement, options?: UIkitDropdownOptions) => UIkitDropdownElement; | ||
interface UIkitFormOptions { | ||
target?: string | boolean; | ||
} | ||
/** | ||
* Create modal dialogs with different styles and transitions | ||
* Documentation: {@link http://getuikit.org/docs/modal.html} | ||
* | ||
* <h2>Events</h2> | ||
* | ||
* <table> | ||
* <tr> | ||
* <th>Name</th> | ||
* <th>Parameter</th> | ||
* <th>Description</th> | ||
* </tr> | ||
* | ||
* <tr> | ||
* <td><code>show.uk.modal</code></td> | ||
* <td>event</td> | ||
* <td>On modal show</td> | ||
* </tr> | ||
* <tr> | ||
* <td><code>hide.uk.modal</code></td> | ||
* <td>event</td> | ||
* <td>On modal hide</td> | ||
* </tr> | ||
* </table> | ||
* @example | ||
* <pre><code> | ||
* $('.modalSelector').on({ | ||
* 'show.uk.modal': function(){ | ||
* console.log("Modal is visible."); | ||
* }, | ||
* | ||
* 'hide.uk.modal': function(){ | ||
* console.log("Element is not visible."); | ||
* } | ||
* }); | ||
* </code></pre> | ||
*/ | ||
type FormCustom = (element: UIkitElement, options?: UIkitFormOptions) => void; | ||
interface UIkitGridOptions { | ||
margin?: string; | ||
'first-column'?: string; | ||
masonry?: boolean; | ||
parallax?: number; | ||
} | ||
type Grid = (element: UIkitElement, options?: UIkitGridOptions) => void; | ||
interface UIkitHeightMatchOptions { | ||
target?: string; | ||
row?: boolean; | ||
} | ||
type HeightMatch = (element: UIkitElement, options?: UIkitHeightMatchOptions) => void; | ||
interface UIkitIconOptions { | ||
icon?: string; | ||
ratio?: number; | ||
} | ||
type Icon = (element: UIkitElement, options?: UIkitIconOptions) => { | ||
svg: Promise<any>; | ||
}; | ||
interface UIkitImageOptions { | ||
dataSrc?: string; | ||
dataSrcset?: string | boolean; | ||
sizes?: string | boolean; | ||
width?: string | boolean; | ||
height?: string | boolean; | ||
offsetTop?: string; | ||
offsetLeft?: string | number; | ||
target?: string | boolean; | ||
} | ||
type Img = (element: UIkitElement, options?: UIkitImageOptions) => void; | ||
interface UIkitLeaderOptions { | ||
fill?: string; | ||
media?: number | string; | ||
} | ||
type Leader = (element: UIkitElement, options?: UIkitLeaderOptions) => void; | ||
interface UIkitMarginOptions { | ||
margin?: string; | ||
'first-column'?: string; | ||
} | ||
type Margin = (element: UIkitElement, options?: UIkitMarginOptions) => void; | ||
interface UIkitModalOptions { | ||
'esc-close'?: boolean; | ||
'bg-close'?: boolean; | ||
stack?: boolean; | ||
container?: string | boolean; | ||
'cls-page'?: string; | ||
'cls-panel'?: string; | ||
'sel-close'?: string; | ||
} | ||
interface UIkitModalElement { | ||
show(): void; | ||
hide(): void; | ||
} | ||
interface Modal { | ||
/** | ||
* Create a alert dialog | ||
* @param message The message to display. Can be Html | ||
*/ | ||
alert(message: string): void; | ||
/** | ||
* Create a confirm dialog | ||
* @param message The message to display. Can be Html | ||
* @param [options={bgclose: true, keyboard: false, modal: false}] The modal options | ||
*/ | ||
confirm(message: string, options?: ModalOptions): void; | ||
/** | ||
* Create a confirm dialog and execute onconfirm on confirmation | ||
* @param message The message to display. Can be Html | ||
* @param onconfirm A function to execute on confirmation | ||
* @param [options={bgclose: true, keyboard: false, modal: false}] The modal options | ||
*/ | ||
confirm(message: string, onconfirm: () => any, options?: ModalOptions): void; | ||
/** | ||
* Create a confirm dialog and execute onconfirm on confirmation and oncancel on cancelation. | ||
* @param message The message to display. Can be Html | ||
* @param onconfirm A function to execute on confirmation | ||
* @param oncancel A function to execute on cancelation | ||
* @param [options={bgclose: true, keyboard: false, modal: false}] The modal options | ||
*/ | ||
confirm(message: string, onconfirm: () => any, oncancel?: () => any, options?: ModalOptions): void; | ||
/** | ||
* Create a prompt dialog, where the user enter information | ||
* @param message The message to display. Can be Html | ||
* @param value A value to init the input | ||
* @param fn A function to execute on submission. The function receive the new value as a parameter | ||
* @param [options={bgclose: true, keyboard: false, modal: false}] The modal options | ||
*/ | ||
prompt(message: string, value: string, onsubmit?: (newValue: string) => any, options?: ModalOptions): void; | ||
/** | ||
* Create a modal that blocks the entire page | ||
* @param content A content to display. Can be Html | ||
* @param [options={bgclose: true, keyboard: false, modal: false}] The modal options | ||
*/ | ||
blockUI(content: string, options?: ModalOptions): ModalElement; | ||
/** | ||
* Select a modal element on page and return it. | ||
* @example | ||
* <pre><code> | ||
* var modal = UIkit.modal(".modalSelector"); | ||
* | ||
* if ( modal.isActive() ) { | ||
* modal.hide(); | ||
* } else { | ||
* modal.show(); | ||
* } | ||
* </code></pre> | ||
*/ | ||
(selector: string|JQuery, options?: ModalOptions): ModalElement; | ||
(element: UIkitElement, options?: UIkitModalOptions): UIkitModalElement; | ||
alert(message: string, options?: UIkitModalOptions): Promise<void>; | ||
confirm(message: string, options?: UIkitModalOptions): Promise<void>; | ||
prompt(content: string, value: string, options?: UIkitModalOptions): Promise<void>; | ||
dialog(content: string, options?: UIkitModalOptions): Promise<void>; | ||
labels: { | ||
ok: string; | ||
cancel: string; | ||
}; | ||
} | ||
/** | ||
* Create a smooth off-canvas sidebar that slides in and out of the page | ||
* Documentation: {@link http://getuikit.org/docs/offcanvas.html} | ||
* <h2>Events:</h2> | ||
* <table class="uk-table uk-table-striped uk-text-nowrap"> | ||
* <tr> | ||
* <th>Name</th> | ||
* <th>Parameter</th> | ||
* <th>Description</th> | ||
* </tr> | ||
* <tr> | ||
* <td><code>show.uk.offcanvas</code></td> | ||
* <td>event, panel, bar</td> | ||
* <td>On offcanvas show</td> | ||
* </tr> | ||
* <tr> | ||
* <td><code>hide.uk.offcanvas</code></td> | ||
* <td>event, panel, bar</td> | ||
* <td>On offcanvas hide</td> | ||
* </tr> | ||
* </table> | ||
*/ | ||
interface OffCanvas { | ||
/** | ||
* Show an off-canvas matching the passed CSS selector | ||
* @param selector A CSS selector | ||
*/ | ||
show(selector: string): void; | ||
/** | ||
* Hide any active offcanvas. Set force to true, if you don't want any | ||
* animation | ||
* @param force When seted to true do not run animations. | ||
* @default false | ||
*/ | ||
hide(force?: boolean): void; | ||
interface UIkitNavOptions { | ||
targets?: string; | ||
toggle?: string; | ||
content?: string; | ||
collapsible?: boolean; | ||
multiple?: boolean; | ||
transition?: string; | ||
animation?: string; | ||
duration?: number; | ||
} | ||
interface LightBoxOptions { | ||
/** | ||
* Group name to group elements as a gallery to show. | ||
* @default false | ||
*/ | ||
group?: string; | ||
/** | ||
* Animation duration between gallery item change | ||
* @default 400 | ||
*/ | ||
interface UIkitNavElement { | ||
index: string | number | UIkitNode; | ||
animate: boolean; | ||
} | ||
type Nav = (element: UIkitElement, options?: UIkitNavOptions) => UIkitNavElement; | ||
interface UIkitNavbarOptions { | ||
align?: string; | ||
mode?: string; | ||
'delay-show'?: number; | ||
'delay-hide'?: number; | ||
boundary?: string; | ||
'boundary-align'?: boolean; | ||
offset?: number; | ||
dropbar?: boolean; | ||
'dropbar-mode'?: string; | ||
duration?: number; | ||
/** | ||
* Allow keyboard navigation | ||
* @default true | ||
*/ | ||
keyboard?: boolean; | ||
} | ||
interface LightBoxItem { | ||
source: string; | ||
type: string; | ||
type Navbar = (element: UIkitElement, options?: UIkitNavbarOptions) => void; | ||
interface UIkitOffcanvasOptions { | ||
mode?: string; | ||
flip?: boolean; | ||
overlay?: boolean; | ||
'esc-close'?: boolean; | ||
'bg-close'?: boolean; | ||
container?: string | boolean; | ||
} | ||
interface LightBoxElement { | ||
/** | ||
* Open the lightbox | ||
*/ | ||
interface UIkitOffcanvasElement { | ||
show(): void; | ||
hide(): void; | ||
} | ||
/** | ||
* Create a fancy lightbox for images and videos utilizing the @see {@link modal|Modal Component} | ||
* Documentation {@link http://getuikit.org/docs/lightbox.html} | ||
* <h2>Events:</h2> | ||
* <table> | ||
* <tr> | ||
* <th>Name</th> | ||
* <th>Parameter</th> | ||
* <th>Description</th> | ||
* </tr> | ||
* <tr> | ||
* <td><code>showitem.uk.lightbox</code></td> | ||
* <td>event, data</td> | ||
* <td>On lightbox show</td> | ||
* </tr> | ||
* </table> | ||
*/ | ||
interface LightBox { | ||
/** | ||
* Create dynamic lightbox | ||
* @param items Group of items on the lightbox | ||
* @return The lightbox element to show | ||
*/ | ||
create(items: LightBoxItem[]): LightBoxElement; | ||
/** | ||
* Init element manually | ||
*/ | ||
(element: string|JQuery, options?: LightBoxOptions): LightBoxElement; | ||
type Offcanvas = (element: UIkitElement, options?: UIkitOffcanvasOptions) => UIkitOffcanvasElement; | ||
interface UIkitScrollOptions { | ||
duration?: number; | ||
offset?: number; | ||
} | ||
type CallbackAutoComplete = () => string; | ||
interface AutoCompleteOptions { | ||
/** | ||
* Data source | ||
* @default [] | ||
*/ | ||
source?: string|string[]|CallbackAutoComplete; | ||
/** | ||
* Min. input length before triggering autocomplete | ||
* @default 3 | ||
*/ | ||
minLength?: number; | ||
/** | ||
* Query name when sending ajax request | ||
* @default search | ||
*/ | ||
param?: string; | ||
/** | ||
* Delay time after stop typing | ||
* @default 300 | ||
*/ | ||
interface UIkitScrollElement { | ||
scrollTo(el: string | UIkitNode): void; | ||
} | ||
type Scroll = (element: UIkitElement, options?: UIkitScrollOptions) => UIkitScrollElement; | ||
interface UIkitScrollspyOptions { | ||
cls?: string; | ||
hidden?: boolean; | ||
'offset-top'?: number; | ||
'offset-left'?: number; | ||
repeat?: boolean; | ||
delay?: number; | ||
} | ||
/** | ||
* Create inputs that allow users to choose from a list of pre-generated values while typing | ||
* Documentation {@link http://getuikit.org/docs/autocomplete.html} | ||
* <h2>Events</h2> | ||
* <table> | ||
* <tr> | ||
* <th>Name</th> | ||
* <th>Parameter</th> | ||
* <th>Description</th> | ||
* </tr> | ||
* <tr> | ||
* <td><code>selectitem.uk.autocomplete</code></td> | ||
* <td>event, data, acobject</td> | ||
* <td>On item selected</td> | ||
* </tr> | ||
* <tr> | ||
* <td><code>show.uk.autocomplete</code></td> | ||
* <td>event</td> | ||
* <td>On autocomplete dropdown show</td> | ||
* </tr> | ||
* </table> | ||
*/ | ||
type AutoComplete = (element: string|JQuery, options?: AutoCompleteOptions) => any; | ||
interface DatePickerOptions { | ||
/** | ||
* Start of the week | ||
* integer (0..6) | ||
* @default 1 | ||
*/ | ||
weekstart?: number; | ||
/** | ||
* Language string definitions | ||
* @default { months:['January',...], weekdays:['Sun',..,'Sat'] } | ||
*/ | ||
i18n?: {}; | ||
/** | ||
* Date format string | ||
* @default 'DD.MM.YYYY' | ||
*/ | ||
format?: string; | ||
/** | ||
* Offset to the input value | ||
* @default 5 | ||
*/ | ||
offsettop?: number; | ||
/** | ||
* Min. date | ||
* bool (false to ignore the option) | ||
* string (date as in format) | ||
* integer (offset in days from current date) | ||
* @default false | ||
*/ | ||
minDate?: string|boolean|number; | ||
/** | ||
* Max. date | ||
* bool (false to ignore the option) | ||
* string (date as in format) | ||
* integer (offset in days from current date) | ||
* @default false | ||
*/ | ||
maxDate?: string|boolean|number; | ||
/** | ||
* Position of the datepicker | ||
* 'auto', 'top', 'bottom' | ||
* @default 'auto' | ||
*/ | ||
pos?: string; | ||
interface UIkitScrollspyNavOptions { | ||
cls?: string; | ||
closest?: string; | ||
scroll?: boolean; | ||
overflow?: boolean; | ||
offset?: number; | ||
} | ||
/** | ||
* Create a toggleable dropdown with an datepicker | ||
* Documentation {@link http://getuikit.org/docs/datepicker.html} | ||
* <h2>Events</h2> | ||
* <table> | ||
* <tr> | ||
* <th>Name</th> | ||
* <th>Parameter</th> | ||
* <th>Description</th> | ||
* </tr> | ||
* <tr> | ||
* <td><code>show.uk.datepicker</code></td> | ||
* <td>event</td> | ||
* <td>On datepicker dropdown show</td> | ||
* </tr> | ||
* <tr> | ||
* <td><code>hide.uk.datepicker</code></td> | ||
* <td>event</td> | ||
* <td>On datepicker dropdown hide</td> | ||
* </tr> | ||
* <tr> | ||
* <td><code>update.uk.datepicker</code></td> | ||
* <td>event</td> | ||
* <td>On calendar rendering</td> | ||
* </tr> | ||
* </table> | ||
*/ | ||
type DatePicker = (element: string|JQuery, options?: DatePickerOptions) => any; | ||
interface HtmlEditorOptions { | ||
/** | ||
* View mode | ||
* Possible values 'split','tab' | ||
* @default 'split' | ||
*/ | ||
mode?: string; | ||
/** | ||
* Button list to appear in the toolbar | ||
* @default [ "bold", "italic", "strike", "link", "picture", ... ] | ||
*/ | ||
toolbar?: string[]; | ||
/** | ||
* Min. browser width when to switch to responsive tab mode when in split mode | ||
* @default 1000 | ||
*/ | ||
maxsplitsize?: number; | ||
/** | ||
* Label string for preview mode | ||
* @default 'Preview' | ||
*/ | ||
lblPreview?: string; | ||
/** | ||
* Label string for code mode | ||
* @default 'Markdown' | ||
*/ | ||
lblCodeview?: string; | ||
type Scrollspy = (element: UIkitElement, options?: UIkitScrollspyOptions) => void; | ||
type ScrollspyNav = (element: UIkitElement, options?: UIkitScrollspyNavOptions) => void; | ||
interface UIkitStickyOptions { | ||
top?: number | string; | ||
bottom?: boolean | string; | ||
offset?: number | string; | ||
animation?: string | boolean; | ||
'cls-active'?: string; | ||
'cls-inactive'?: string; | ||
'width-element'?: string | boolean; | ||
'show-on-up'?: boolean; | ||
media?: number | string | boolean; | ||
'target-offset'?: boolean | number; | ||
} | ||
/** | ||
* Create a rich HTML or markdown editor with an immediate preview and syntax highlighting | ||
* Documentation {@link http://getuikit.org/docs/htmleditor.html} | ||
*/ | ||
type HtmlEditor = (element: string|JQuery, options?: HtmlEditorOptions) => any; | ||
interface SliderOptions { | ||
/** | ||
* Center items mode | ||
* @default false | ||
*/ | ||
center?: boolean; | ||
/** | ||
* Mouse movement threshold in pixel until trigger element dragging | ||
* @default true | ||
*/ | ||
threshold?: boolean; | ||
/** | ||
* Infinite scrolling | ||
* @default true | ||
*/ | ||
infinite?: boolean; | ||
/** | ||
* Class added on active item in center mode | ||
* @default uk-active | ||
*/ | ||
activecls?: string; | ||
/** | ||
* Defines whether or not the slider items should switch automatically | ||
* @default false | ||
*/ | ||
autoplay?: boolean; | ||
/** | ||
* Pause autoplay when hovering a slider | ||
* @default true | ||
*/ | ||
pauseOnHover?: boolean; | ||
/** | ||
* Defines the timespan between switching slider items | ||
* @default 7000 | ||
*/ | ||
autoplayInterval?: number; | ||
type Sticky = (element: UIkitElement, options?: UIkitStickyOptions) => void; | ||
interface UIkitSvgOptions { | ||
src?: string; | ||
'stroke-animation'?: boolean; | ||
} | ||
/** | ||
* Create a list of items to use as a responsive carousel slider | ||
* Documentation {@link http://getuikit.org/docs/slider.html} | ||
* <h2>Events</h2> | ||
* <table class="uk-table uk-table-striped uk-text-nowrap"> | ||
* <tr> | ||
* <th>Name</th> | ||
* <th>Parameter</th> | ||
* <th>Description</th> | ||
* </tr> | ||
* <tr> | ||
* <td><code>focusitem.uk.slider</code></td> | ||
* <td>event, index, item</td> | ||
* <td>On item focus</td> | ||
* </tr> | ||
* </table> | ||
*/ | ||
type Slider = (element: string|JQuery, options?: SliderOptions) => any; | ||
interface SlideSetOptions { | ||
/** | ||
* Default visible items in a set | ||
* @default 1 | ||
*/ | ||
default?: number; | ||
/** | ||
* Visible items in a set at small breakpoint | ||
* @default null | ||
*/ | ||
small?: number; | ||
/** | ||
* Visible items in a set at medium breakpoint | ||
* @default null | ||
*/ | ||
medium?: number; | ||
/** | ||
* Visible items in a set at large breakpoint | ||
* @default null | ||
*/ | ||
large?: number; | ||
/** | ||
* Visible items in a set at xlarge breakpoint | ||
* @default null | ||
*/ | ||
xlarge?: number; | ||
/** | ||
* Animation name | ||
* @default 'fade' | ||
*/ | ||
type Svg = (element: UIkitElement, options?: UIkitSvgOptions) => { | ||
svg: Promise<any>; | ||
}; | ||
interface UIkitSwiterOptions { | ||
connect?: string; | ||
toggle?: string; | ||
active?: number; | ||
animation?: string; | ||
/** | ||
* Animation duration in ms | ||
* @default 200 | ||
*/ | ||
duration?: number; | ||
/** | ||
* Animation delay between items in a set | ||
* @default 100 | ||
*/ | ||
delay?: number; | ||
/** | ||
* Items filter | ||
* @default "" | ||
*/ | ||
filter?: string; | ||
/** | ||
* Defines whether or not the slideset items should switch automatically. | ||
* @default false | ||
*/ | ||
autoplay?: boolean; | ||
/** | ||
* Pause autoplay when hovering a slideset. | ||
* @default true | ||
*/ | ||
pauseOnHover?: boolean; | ||
/** | ||
* Defines the timespan between switching slideset items. | ||
* @default 7000 | ||
*/ | ||
autoplayInterval?: number; | ||
swiping?: boolean; | ||
} | ||
/** | ||
* Create sets and groups of items, allowing to loop through the sets. | ||
* Documentation {@link http://getuikit.org/docs/slideset.html} | ||
* <h2>Events</h2> | ||
* <table> | ||
* <tr> | ||
* <th>Name</th> | ||
* <th>Parameter</th> | ||
* <th>Description</th> | ||
* </tr> | ||
* <tr> | ||
* <td><code>show.uk.slideset</code></td> | ||
* <td>event, set</td> | ||
* <td>On set show</td> | ||
* </tr> | ||
* </table> | ||
*/ | ||
type SlideSet = (element: string|JQuery, options?: SlideSetOptions) => any; | ||
interface SlideShowOptions { | ||
/** | ||
* Defines the preferred transition between items. | ||
* @default 'fade | ||
*/ | ||
interface UIkitSwitcherElement { | ||
show(index: string | number | UIkitNode): void; | ||
} | ||
type Switcher = (element: UIkitElement, options?: UIkitSwiterOptions) => UIkitSwitcherElement; | ||
interface UIkitTabOptions { | ||
connect?: string; | ||
toggle?: string; | ||
active?: number; | ||
animation?: string; | ||
duration?: number; | ||
swiping?: boolean; | ||
media?: number | string; | ||
} | ||
/** | ||
* Defines the transition duration. | ||
* @default 500 | ||
*/ | ||
interface UIkitTabElement { | ||
show(index: string | number | UIkitNode): void; | ||
} | ||
type Tab = (element: UIkitElement, options?: UIkitTabOptions) => UIkitTabElement; | ||
interface UIkitToggleOptions { | ||
target?: string; | ||
mode?: string; | ||
cls?: string; | ||
media?: number | string; | ||
animation?: string; | ||
duration?: number; | ||
queued?: boolean; | ||
} | ||
/** | ||
* Defines the slideshow height. | ||
* @default 'auto' | ||
*/ | ||
height?: string; | ||
interface UIkitToggleElement { | ||
toggle(): void; | ||
} | ||
/** | ||
* Defines the first slideshow item to be displayed. | ||
* @default 0 | ||
*/ | ||
start?: number; | ||
type Toggle = (element: UIkitElement, options?: UIkitToggleOptions) => UIkitToggleElement; | ||
/** | ||
* Defines whether or not the slideshow items should switch automatically. | ||
* @default false | ||
*/ | ||
autoplay?: boolean; | ||
interface UIkitVideoOptions { | ||
autoplay?: boolean | string; | ||
automute?: boolean; | ||
} | ||
/** | ||
* Pause autoplay when hovering a slideshow. | ||
* @default true | ||
*/ | ||
pauseOnHover?: boolean; | ||
type Video = (element: UIkitElement, options?: UIkitVideoOptions) => void; | ||
/** | ||
* Defines the timespan between switching slideshow items. | ||
* @default 7000 | ||
*/ | ||
autoplayInterval?: number; | ||
// Components | ||
/** | ||
* Defines whether or not a video starts automatically. | ||
* @default true | ||
*/ | ||
videoautoplay?: boolean; | ||
interface UIkitCountdownOptions { | ||
date?: string | boolean; | ||
} | ||
/** | ||
* Defines whether or not a video is muted. | ||
* @default false | ||
*/ | ||
videomute?: boolean; | ||
interface UIkitCountdownElement { | ||
start(): void; | ||
stop(): void; | ||
} | ||
/** | ||
* Defines whether or not the Ken Burns effect is active. If kenburns is a numeric value, it will be used as | ||
* the animation duration. | ||
* @default false | ||
*/ | ||
kenburns?: boolean; | ||
type Countdown = (element: UIkitElement, options?: UIkitCountdownOptions) => UIkitCountdownElement; | ||
/** | ||
* Animation series. | ||
* @default 'uk-animation-middle-left, uk-animation-top-right, uk-animation-bottom-left, uk-animation-top-center,uk-animation-bottom-right' | ||
*/ | ||
kenburnsanimations?: string; | ||
interface UIkitFilterOptions { | ||
target?: string; | ||
selActive?: string | boolean; | ||
} | ||
/** | ||
* Defines the number of slices, if a "Slice" transition is set. | ||
* @default 15 | ||
*/ | ||
slices?: number; | ||
} | ||
/** | ||
* Create a responsive image or video slideshow with stunning transition effects, fullscreen mode and overlays. | ||
* Documentation {@link http://getuikit.org/docs/slideshow.html} | ||
* <h2>Events</h2> | ||
* <table> | ||
* <tr> | ||
* <th>Name</th> | ||
* <th>Parameter</th> | ||
* <th>Description</th> | ||
* </tr> | ||
* <tr> | ||
* <td><code>show.uk.slideshow</code></td> | ||
* <td>event, next slide</td> | ||
* <td>On showing a new slide (after animation is finished)</td> | ||
* </tr> | ||
* </table> | ||
*/ | ||
type SlideShow = (element: string|JQuery, options: SlideShowOptions) => any; | ||
interface ParallaxOptions { | ||
/** | ||
* Animation velocity during scrolling | ||
* @default 0.5 | ||
*/ | ||
type Filter = (element: UIkitElement, options?: UIkitFilterOptions) => void; | ||
interface UIkitLightboxPanelOptions { | ||
animation?: string; | ||
autoplay?: boolean; | ||
'autoplay-interval'?: number; | ||
'pause-on-hover'?: boolean; | ||
'video-autoplay'?: boolean; | ||
index?: number; | ||
velocity?: number; | ||
/** | ||
* Element dimension reference for animation duration. | ||
* @default false | ||
*/ | ||
target?: boolean; | ||
/** | ||
* Animation range depending on the viewport. | ||
* <h2>Possible value</h2> | ||
* float (0 to 1) | ||
* @default false | ||
*/ | ||
viewport?: number; | ||
/** | ||
* Condition for the active status with a width as integer (e.g. 640) or a css media query | ||
* @default false | ||
* <h2>Possible Value</h2> | ||
* integer / string | ||
*/ | ||
media?: number|string; | ||
preload?: number; | ||
items?: object[]; | ||
template?: string; | ||
'delay-controls'?: number; | ||
} | ||
/** | ||
* Animate CSS properties depending on the scroll position of the document. | ||
* Documentation {@link http://getuikit.org/docs/parallax.html} | ||
*/ | ||
type Parallax = (element: string|JQuery, options: ParallaxOptions) => any; | ||
interface AccordionOptions { | ||
/** | ||
* Show first item on init | ||
* @default true | ||
* <h2>Possible value</h2> | ||
* boolean | ||
*/ | ||
showfirst?: boolean; | ||
/** | ||
* Allow multiple open items | ||
* @default true | ||
* <h2>Possible value</h2> | ||
* boolean | ||
*/ | ||
collapse?: boolean; | ||
/** | ||
* Animate toggle | ||
* @default true | ||
* <h2>Possible value</h2> | ||
* boolean | ||
*/ | ||
animate?: boolean; | ||
/** | ||
* Animation function | ||
* @default swing | ||
* <h2>Possible value</h2> | ||
* string | ||
*/ | ||
easing?: string; | ||
/** | ||
* Animation duration | ||
* @default 300 | ||
* <h2>Possible value</h2> | ||
* integer | ||
*/ | ||
duration?: number; | ||
/** | ||
* Css selector for toggles | ||
* @default .uk-accordion-title | ||
* <h2>Possible value</h2> | ||
* string | ||
*/ | ||
interface UIkitLightboxPanelElement { | ||
show(index: number): void; | ||
hide(): void; | ||
startAutoplay(): void; | ||
stopAutoplay(): void; | ||
} | ||
interface LightboxPanel { | ||
(optionsOrElement: UIkitLightboxPanelOptions | UIkitElement): UIkitLightboxPanelElement; | ||
} | ||
interface UIkitLightboxOptions { | ||
animation?: string; | ||
autoplay?: number; | ||
'autoplay-interval'?: number; | ||
'pause-on-hover'?: boolean; | ||
'video-autoplay'?: boolean; | ||
index?: string; | ||
toggle?: string; | ||
/** | ||
* Css selector for content containers | ||
* @default .uk-accordion-content | ||
* <h2>Possible value</h2> | ||
* string | ||
*/ | ||
containers?: string; | ||
/** | ||
* Class to add when an item is active | ||
* @default uk-active | ||
* <h2>Possible value</h2> | ||
* string | ||
*/ | ||
clsactive?: string; | ||
} | ||
/** | ||
* Create a list of items, allowing each item's content to be expanded and collapsed by clicking its header. | ||
* Documentation {@link http://getuikit.org/docs/accordion.html} | ||
* <h2>Events</h2> | ||
* <table class="uk-table uk-table-striped uk-text-nowrap"> | ||
* <tr> | ||
* <th>Name</th> | ||
* <th>Parameter</th> | ||
* <th>Description</th> | ||
* </tr> | ||
* <tr> | ||
* <td><code>toggle.uk.accordion</code></td> | ||
* <td>event, active, toggle, content</td> | ||
* <td>On item toggle</td> | ||
* </tr> | ||
* </table> | ||
*/ | ||
type Accordion = (element: string|JQuery, options: AccordionOptions) => any; | ||
interface NotifyOptions { | ||
/** | ||
* The message to display | ||
*/ | ||
message?: string; | ||
/** | ||
* A notification can be styled by adding a status to the message to indicate an info, success, warning or a | ||
* danger status. | ||
* <h2>Possible values</h2> | ||
* info, sucess, warning, danger | ||
* If you want to create one set its style with the CSS class uk-notify-message-yourStatus | ||
* @default 'info' | ||
*/ | ||
status?: string; | ||
interface UIkitLightboxElement { | ||
show(index: number): void; | ||
hide(): void; | ||
} | ||
/** | ||
* Amount of tiem in milliseconds a messa is visible. Set to 0 for sticky message | ||
* @default 5000 | ||
*/ | ||
type Lightbox = (element: UIkitElement, options?: UIkitLightboxOptions) => UIkitLightboxElement; | ||
interface UIkitNotificationOptions { | ||
message?: string; | ||
status?: 'primary' | 'success' | 'warning' | 'danger'; | ||
timeout?: number; | ||
group?: string; | ||
pos?: 'top-left' | 'top-center' | 'top-right' | 'bottom-left' | 'bottom-center' | 'bottom-right'; | ||
} | ||
/** | ||
* Adjust the notification's position to different corners. | ||
* @default 'top-center' | ||
* <h2>Possible values</h2> | ||
* top-center, top-left, top-right, bottom-center, bottom-left, bottom-right | ||
* If you want to create one value set its style with the CSS uk-notify-yourPosition | ||
*/ | ||
pos?: string; | ||
interface UIkitNotificationElement { | ||
close(immediate: boolean): void; | ||
} | ||
/** | ||
* Create toggleable notifications that fade out automatically | ||
* Documentation {@link http://getuikit.org/docs/notify.html} | ||
*/ | ||
interface Notify { | ||
/** | ||
* Show a notification | ||
* @param message The html message | ||
* @param [status] The status or options | ||
*/ | ||
(message: string, status?: string|NotifyOptions): any; | ||
/** | ||
* Show a notification | ||
* @param options Options | ||
*/ | ||
(options: NotifyOptions): any; | ||
interface Notification { | ||
(options: UIkitNotificationOptions): UIkitNotificationElement; | ||
(message: string, optionsOrStatus?: UIkitNotificationOptions | string): UIkitNotificationElement; | ||
} | ||
interface SearchOptions { | ||
/** | ||
* Data source url | ||
* @default '' | ||
* <h2>Possible value</h2> | ||
* string | ||
*/ | ||
source?: string; | ||
/** | ||
* Min. input length before triggering autocomplete | ||
* @default 3 | ||
* <h2>Possible value</h2> | ||
* integer | ||
*/ | ||
minLength?: number; | ||
interface UIkitParallaxOptions { | ||
easing?: number; | ||
target?: string; | ||
viewport?: number; | ||
media?: number | string; | ||
} | ||
/** | ||
* Query name when sending ajax request | ||
* @default search | ||
* <h2>Possible value</h2> | ||
* string | ||
*/ | ||
param?: string; | ||
type Parallax = (element: UIkitElement, options?: UIkitParallaxOptions) => void; | ||
/** | ||
* Delay time after stop typing | ||
* @default 300 | ||
* <h2>Possible value</h2> | ||
* integer | ||
*/ | ||
delay?: number; | ||
interface UIkitSliderOptions { | ||
autoplay?: boolean; | ||
'autoplay-interval'?: number; | ||
center?: boolean; | ||
draggable?: boolean; | ||
easing?: string; | ||
finite?: boolean; | ||
index?: number; | ||
'pause-on-hover'?: boolean; | ||
sets?: boolean; | ||
velocity?: number; | ||
} | ||
/** | ||
* Easily create a nicely looking search. | ||
* Documentation {@link http://getuikit.org/docs/search.html} | ||
*/ | ||
type Search = (element: string|JQuery, options: SearchOptions) => any; | ||
interface NestableOptions { | ||
/** | ||
* List group | ||
* @default false | ||
* <h2>Possible value</h2> | ||
* string | ||
*/ | ||
group?: string; | ||
/** | ||
* Max nesting level | ||
* @default 10 | ||
* <h2>Possible value</h2> | ||
* integer | ||
*/ | ||
maxDepth?: number; | ||
/** | ||
* Pixel threshold before starting to drag | ||
* @default 20 | ||
* <h2>Possible value</h2> | ||
* integer | ||
*/ | ||
threshold?: number; | ||
/** | ||
* List node name | ||
* @default ul | ||
* <h2>Possible value</h2> | ||
* string | ||
*/ | ||
listNodeName?: string; | ||
/** | ||
* Item node name | ||
* @default li | ||
* <h2>Possible value</h2> | ||
* string | ||
*/ | ||
itemNodeName?: string; | ||
/** | ||
* List base class | ||
* @default uk-nestable | ||
* <h2>Possible value</h2> | ||
* string | ||
*/ | ||
listBaseClass?: string; | ||
/** | ||
* List class | ||
* @default uk-nestable-list | ||
* <h2>Possible value</h2> | ||
* string | ||
*/ | ||
listClass?: string; | ||
/** | ||
* List item class | ||
* @default uk-nestable-list-item | ||
* <h2>Possible value</h2> | ||
* string | ||
*/ | ||
listitemClass?: string; | ||
/** | ||
* Item class | ||
* @default uk-nestable-item | ||
* <h2>Possible value</h2> | ||
* string | ||
*/ | ||
itemClass?: string; | ||
/** | ||
* Class added to dragged list | ||
* @default uk-nestable-list-dragged | ||
* <h2>Possible value</h2> | ||
* string | ||
*/ | ||
dragClass?: string; | ||
/** | ||
* Class added to <code><html></code> when moving | ||
* @default uk-nestable-moving | ||
* <h2>Possible value</h2> | ||
* string | ||
*/ | ||
movingClass?: string; | ||
/** | ||
* Class for drag handle | ||
* @default uk-nestable-handle | ||
* <h2>Possible value</h2> | ||
* string | ||
*/ | ||
handleClass?: string; | ||
/** | ||
* Class for collapsed items | ||
* @default uk-nestable-collapsed | ||
* <h2>Possible value</h2> | ||
* string | ||
*/ | ||
collapsedClass?: string; | ||
/** | ||
* Class for placeholder of currently dragged element | ||
* @default uk-nestable-placeholder | ||
* <h2>Possible value</h2> | ||
* string | ||
*/ | ||
placeClass?: string; | ||
/** | ||
* Elements with this class will not trigger dragging. Useful when having the complete item draggable and not | ||
* just the handle. | ||
* @default uk-nestable-nodrag | ||
* <h2>Possible value</h2> | ||
* string | ||
*/ | ||
noDragClass?: string; | ||
/** | ||
* Class for empty lists | ||
* @default uk-nestable-empty | ||
* <h2>Possible value</h2> | ||
* string | ||
*/ | ||
emptyClass?: string; | ||
interface UIkitSliderElement { | ||
show(index: number): void; | ||
startAutoplay(): void; | ||
stopAutoplay(): void; | ||
} | ||
/** | ||
* Create nestable lists that can be sorted by drag and drop. | ||
* Documentation {@link http://getuikit.org/docs/nestable.html} | ||
* <h2>Events</h2> | ||
* <table> | ||
* <tr> | ||
* <th>Name</th> | ||
* <th>Parameter</th> | ||
* <th>Description</th> | ||
* </tr> | ||
* <tr> | ||
* <td><code>start.uk.nestable</code></td> | ||
* <td>event, nestable object</td> | ||
* <td>On nestable drag start</td> | ||
* </tr> | ||
* <tr> | ||
* <td><code>move.uk.nestable</code></td> | ||
* <td>event, nestable object</td> | ||
* <td>On nestable move item</td> | ||
* </tr> | ||
* <tr> | ||
* <td><code>stop.uk.nestable</code></td> | ||
* <td>event, nestable object</td> | ||
* <td>On nestable stop dragging</td> | ||
* </tr> | ||
* <tr> | ||
* <td><code>change.uk.nestable</code></td> | ||
* <td>event, sortable object, dragged element, action</td> | ||
* <td>On nestable change item</td> | ||
* </tr> | ||
* </table> | ||
*/ | ||
type Nestable = (element: string|JQuery, options: NestableOptions) => any; | ||
interface SortableOptions { | ||
/** | ||
* List group | ||
* @default false | ||
* <h2>Possible value</h2> | ||
* string | ||
*/ | ||
group?: string; | ||
/** | ||
* Animation speed in ms | ||
* @default 150 | ||
* <h2>Possible value</h2> | ||
* integer | ||
*/ | ||
type Slider = (element: UIkitElement, options?: UIkitSliderOptions) => UIkitSliderElement; | ||
interface UIkitSlideshowOptions { | ||
animation?: string; | ||
/** | ||
* Mouse movement threshold in pixel until trigger element dragging | ||
* @default 10 | ||
* <h2>Possible value</h2> | ||
* integer | ||
*/ | ||
threshold?: string; | ||
/** | ||
* Custom class to define elements which can trigger sorting | ||
* @default '' | ||
* <h2>Possible value</h2> | ||
* string | ||
*/ | ||
handleClass?: string; | ||
/** | ||
* Custom class added to the dragged element | ||
* @default '' | ||
* <h2>Possible value</h2> | ||
* string | ||
*/ | ||
dragCustomClass?: string; | ||
autoplay?: boolean; | ||
'autoplay-interval'?: number; | ||
draggable?: boolean; | ||
easing?: string; | ||
finite?: boolean; | ||
'pause-on-hover'?: boolean; | ||
index?: number; | ||
velocity?: number; | ||
ratio?: string | number; | ||
'min-height'?: boolean | number; | ||
'max-height'?: boolean | number; | ||
} | ||
/** | ||
* Create sortable grids and lists to rearrange the order of its elements. | ||
* Documentation {@link http://getuikit.org/docs/sortable.html} | ||
* <h2>Events</h2> | ||
* <table class="uk-table uk-table-striped uk-text-nowrap"> | ||
* <tr> | ||
* <th>Name</th> | ||
* <th>Parameter</th> | ||
* <th>Description</th> | ||
* </tr> | ||
* <tr> | ||
* <td><code>start.uk.sortable</code></td> | ||
* <td>event, sortable object, dragged element</td> | ||
* <td>On sortable drag start</td> | ||
* </tr> | ||
* <tr> | ||
* <td><code>move.uk.sortable</code></td> | ||
* <td>event, sortable object</td> | ||
* <td>On sortable move item</td> | ||
* </tr> | ||
* <tr> | ||
* <td><code>stop.uk.sortable</code></td> | ||
* <td>event, sortable object, dragged element</td> | ||
* <td>On sortable stop dragging</td> | ||
* </tr> | ||
* <tr> | ||
* <td><code>change.uk.sortable</code></td> | ||
* <td>event, sortable object, dragged element, action</td> | ||
* <td>On sortable change item</td> | ||
* </tr> | ||
* </table> | ||
*/ | ||
type Sortable = (element: string|JQuery, options: SortableOptions) => any; | ||
interface StickyOptions { | ||
/** | ||
* Top offset whent sticky should be triggered | ||
* @default 0 | ||
* <h2>Possible value</h2> | ||
* integer | ||
*/ | ||
top?: number; | ||
/** | ||
* UIkit animation class | ||
* @default '' | ||
* <h2>Possible value</h2> | ||
* string | ||
*/ | ||
animation?: string; | ||
/** | ||
* Init class when the element is sticky for the first time | ||
* @default uk-sticky-init | ||
* <h2>Possible value</h2> | ||
* string | ||
*/ | ||
clsinit?: string; | ||
/** | ||
* Active class to add, when element is sticky | ||
* @default uk-active | ||
* <h2>Possible value</h2> | ||
* string | ||
*/ | ||
clsactive?: string; | ||
/** | ||
* Class to add, when element is not sticky | ||
* @default '' | ||
* <h2>Possible value</h2> | ||
* string | ||
*/ | ||
clsinactive?: string; | ||
/** | ||
* Css selector where to get the width from in sticky mode. By default it takes the width from the created wrapper element. | ||
* @default '' | ||
* <h2>Possible value</h2> | ||
* string | ||
*/ | ||
getWidthFrom?: string; | ||
/** | ||
* Condition for the active status with a width as integer (e.g. 640) or a css media query | ||
* @default false | ||
* <h2>Possible value</h2> | ||
* integer / string | ||
*/ | ||
media?: number|string; | ||
/** | ||
* Make sure that a sticky element is not over a targeted element via location hash on dom-ready. | ||
* @default false | ||
* <h2>Possible value</h2> | ||
* boolean | ||
*/ | ||
target?: boolean; | ||
/** | ||
* Show sticky element only when scrolling up. | ||
* @default false | ||
* <h2>Possible value</h2> | ||
* boolean | ||
*/ | ||
showup?: boolean; | ||
/** | ||
* Set to <code>true</code> to bind sticky to the parent or a Css selector to bind sticky to a specific element. | ||
* @default false | ||
* <h2>Possible value</h2> | ||
* mixed | ||
*/ | ||
boundary?: boolean|string; | ||
interface UIkitSlidershowElement { | ||
show(index: number): void; | ||
startAutoplay(): void; | ||
stopAutoplay(): void; | ||
} | ||
/** | ||
* Make elements remain at the top of the viewport, like a sticky navbar. | ||
* Documentation {@link http://getuikit.org/docs/sticky.html} | ||
* <h2>Events</h2> | ||
* <table class="uk-table uk-table-striped uk-text-nowrap"> | ||
* <tr> | ||
* <th>Name</th> | ||
* <th>Parameter</th> | ||
* <th>Description</th> | ||
* </tr> | ||
* <tr> | ||
* <td><code>active.uk.sticky</code></td> | ||
* <td>event</td> | ||
* <td>Element getting sticky</td> | ||
* </tr> | ||
* <tr> | ||
* <td><code>inactive.uk.sticky</code></td> | ||
* <td>event</td> | ||
* <td>Element leaving sticky mode</td> | ||
* </tr> | ||
* </table> | ||
*/ | ||
type Sticky = (element: string|JQuery, options: StickyOptions) => any; | ||
interface TimepickerOptions { | ||
/** | ||
* Defines the preferred time notation | ||
* @default '24h' | ||
* <h2>Possible value</h2> | ||
* '24h' or '12h' | ||
*/ | ||
format?: string; | ||
/** | ||
* Start time | ||
* @default 0 | ||
* <h2>Possible value</h2> | ||
* Integer between 0 and 24 | ||
*/ | ||
start?: number; | ||
/** | ||
* End time | ||
* @default 24 | ||
* <h2>Possible value</h2> | ||
* Integer between 0 and 24 | ||
*/ | ||
end?: number; | ||
type Slidershow = (element: UIkitElement, options?: UIkitSlideshowOptions) => UIkitSlidershowElement; | ||
interface UIkitSortableOptions { | ||
group?: string; | ||
animation?: number; | ||
threshold?: number; | ||
'cls-item'?: string; | ||
'cls-placeholder'?: string; | ||
'cls-drag'?: string; | ||
'cls-drag-state'?: string; | ||
'cls-base'?: string; | ||
'cls-no-drag'?: string; | ||
'cls-empty'?: string; | ||
'cls-custom': string; | ||
handle?: string; | ||
} | ||
/** | ||
* Create a timepicker which can easily be used by selecting a time value from a pre filled dropdown. | ||
* Documentation {@link http://getuikit.org/docs/timepicker.html} | ||
*/ | ||
type Timepicker = (element: string|JQuery, options: TimepickerOptions) => any; | ||
interface TooltipOptions { | ||
/** | ||
* Offset to the source element | ||
* @default 5 | ||
* <h2>Possible value</h2> | ||
* integer | ||
*/ | ||
offset?: number; | ||
/** | ||
* Tooltip position | ||
* @default 'top' | ||
* <h2>Possible value</h2> | ||
* string | ||
*/ | ||
type Sortable = (element: UIkitElement, options?: UIkitSortableOptions) => void; | ||
interface UIkitTooltipOptions { | ||
title?: string; | ||
pos?: string; | ||
/** | ||
* Fade in tooltip | ||
* @default false | ||
* <h2>Possible value</h2> | ||
* boolean | ||
*/ | ||
animation?: boolean; | ||
/** | ||
* Delay tooltip show in ms | ||
* @default 0 | ||
* <h2>Possible value</h2> | ||
* integer | ||
*/ | ||
offset?: number | boolean; | ||
animation?: string; | ||
duration?: number; | ||
delay?: number; | ||
/** | ||
* Custom class to add on show | ||
* @default '' | ||
* <h2>Possible value</h2> | ||
* string | ||
*/ | ||
cls?: string; | ||
/** | ||
* Toggled active class | ||
* @default 'uk-active' | ||
* <h2>Possible value</h2> | ||
* string | ||
*/ | ||
activeClass?: string; | ||
} | ||
/** | ||
* Easily create a nicely looking tooltip. | ||
* Documentation {@link http://getuikit.org/docs/tooltip.html} | ||
*/ | ||
type Tooltip = (element: string|JQuery, options: TooltipOptions) => any; | ||
interface UploadOptions { | ||
/** | ||
* Target url for the upload | ||
* @default '' | ||
* <h2>Possible value</h2> | ||
* string | ||
*/ | ||
action?: string; | ||
/** | ||
* Send each file one by one | ||
* @default true | ||
* <h2>Possible value</h2> | ||
* boolean | ||
*/ | ||
single?: boolean; | ||
/** | ||
* Post query name | ||
* @default files[] | ||
* <h2>Possible value</h2> | ||
* string | ||
*/ | ||
param?: string; | ||
/** | ||
* Additional request parameters | ||
* @default {} | ||
* <h2>Possible value</h2> | ||
* JSON Object | ||
*/ | ||
params?: {}; | ||
/** | ||
* File filter | ||
* @default *.* | ||
* <h2>Possible value</h2> | ||
* string | ||
*/ | ||
allow?: string; | ||
/** | ||
* Limit the number of files to upload | ||
* @default false | ||
* <h2>Possible value</h2> | ||
* integer | ||
*/ | ||
filelimit?: number; | ||
/** | ||
* Response type from server | ||
* @default text | ||
* <h2>Possible Value</h2> | ||
* (text|json) | ||
*/ | ||
"type"?: string; | ||
before?(settings: UploadOptions, files: string|string[]): any; | ||
beforeAll?(files: string|string[]): any; | ||
beforeSend?(xhr: XMLHttpRequest): any; | ||
progress?(percent: number): any; | ||
complete?(response: any, xhr: XMLHttpRequest): any; | ||
allcomplete?(response: any, xhr: XMLHttpRequest): any; | ||
notallowed?(file: string|string[], settings: UploadOptions): any; | ||
loadstart?(event: any): any; | ||
load?(event: any): any; | ||
loadend?(event: any): any; | ||
error?(event: any): any; | ||
abort?(event: any): any; | ||
readystatechange?(event: any): any; | ||
interface UIkitTooltipElement { | ||
show(): void; | ||
hide(): void; | ||
} | ||
/** | ||
* Allow users to upload files through a file input form element or a placeholder area. | ||
* Documentation {@link http://getuikit.org/docs/upload.html} | ||
* <h2>Callbacks</h2> | ||
* <table class="uk-table uk-table-striped"> | ||
* <tr> | ||
* <th>Name</th> | ||
* <th>Parameter</th> | ||
* </tr> | ||
* <tr> | ||
* <td><code>before</code></td> | ||
* <td>settings, files</td> | ||
* </tr> | ||
* <tr> | ||
* <td><code>beforeAll</code></td> | ||
* <td>files</td> | ||
* </tr> | ||
* <tr> | ||
* <td><code>beforeSend</code></td> | ||
* <td>xhr</td> | ||
* </tr> | ||
* <tr> | ||
* <td><code>progress</code></td> | ||
* <td>percent</td> | ||
* </tr> | ||
* <tr> | ||
* <td><code>complete</code></td> | ||
* <td>response, xhr</td> | ||
* </tr> | ||
* <tr> | ||
* <td><code>allcomplete</code></td> | ||
* <td>response, xhr</td> | ||
* </tr> | ||
* <tr> | ||
* <td><code>notallowed</code></td> | ||
* <td>file, settings</td> | ||
* </tr> | ||
* <tr> | ||
* <td><code>loadstart</code></td> | ||
* <td>event</td> | ||
* </tr> | ||
* <tr> | ||
* <td><code>load</code></td> | ||
* <td>event</td> | ||
* </tr> | ||
* <tr> | ||
* <td><code>loadend</code></td> | ||
* <td>event</td> | ||
* </tr> | ||
* <tr> | ||
* <td><code>error</code></td> | ||
* <td>event</td> | ||
* </tr> | ||
* <tr> | ||
* <td><code>abort</code></td> | ||
* <td>event</td> | ||
* </tr> | ||
* <tr> | ||
* <td><code>readystatechange</code></td> | ||
* <td>event</td> | ||
* </tr> | ||
* </table> | ||
*/ | ||
type Upload = (element: string|JQuery, options: UploadOptions) => any; | ||
type Tooltip = (element: UIkitElement, options?: UIkitTooltipOptions) => UIkitTooltipElement; | ||
interface UIkitUploadOptions { | ||
url?: string; | ||
multiple?: boolean; | ||
name?: string; | ||
params?: object; | ||
allow?: string | boolean; | ||
mime?: string | boolean; | ||
concurrent?: number; | ||
type?: string; | ||
method?: string; | ||
'msg-invalid-mime'?: string; | ||
'msg-invalid-name'?: string; | ||
'cls-dragover'?: string; | ||
abort?: object; | ||
'before-all'?: object; | ||
'before-send'?: object; | ||
complete?: object; | ||
'complete-all'?: object; | ||
error?: object; | ||
load?: object; | ||
'load-end'?: object; | ||
'load-start'?: object; | ||
progress?: object; | ||
fail?: object; | ||
} | ||
type Upload = (element: UIkitElement, options?: UIkitUploadOptions) => void; | ||
// Core | ||
const accordion: Accordion; | ||
const alert: Alert; | ||
const cover: Cover; | ||
const drop: Drop; | ||
const dropdown: Dropdown; | ||
const formCustom: FormCustom; | ||
const grid: Grid; | ||
const heightMatch: HeightMatch; | ||
const icon: Icon; | ||
const image: Img; | ||
const leader: Leader; | ||
const margin: Margin; | ||
const modal: Modal; | ||
const lightbox: LightBox; | ||
const offcanvas: OffCanvas; | ||
const autocomplete: AutoComplete; | ||
const datepicker: DatePicker; | ||
const htmleditor: HtmlEditor; | ||
const nav: Nav; | ||
const navbar: Navbar; | ||
const offcanvas: Offcanvas; | ||
const scroll: Scroll; | ||
const scrollspy: Scrollspy; | ||
const scrollspyNav: ScrollspyNav; | ||
const sticky: Sticky; | ||
const svg: Svg; | ||
const switcher: Switcher; | ||
const tab: Tab; | ||
const toggle: Toggle; | ||
const video: Video; | ||
// Components | ||
const notification: Notification; | ||
const countdown: Countdown; | ||
const filter: Filter; | ||
const lightbox: Lightbox; | ||
const lightboxPanel: LightboxPanel; | ||
const parallax: Parallax; | ||
const slider: Slider; | ||
const slideset: SlideSet; | ||
const slideshow: SlideShow; | ||
const parallax: Parallax; | ||
const accordion: Accordion; | ||
const notify: Notify; | ||
const search: Search; | ||
const nestable: Nestable; | ||
const slideshow: Slidershow; | ||
const sortable: Sortable; | ||
const sticky: Sticky; | ||
const timepicker: Timepicker; | ||
const tooltip: Tooltip; | ||
const uploadSelect: Upload; | ||
const uploadDrop: Upload; | ||
const upload: Upload; | ||
} | ||
export default UIkit; |
{ | ||
"name": "@types/uikit", | ||
"version": "2.27.7", | ||
"version": "3.3.0", | ||
"description": "TypeScript definitions for uikit", | ||
@@ -16,16 +16,20 @@ "license": "MIT", | ||
"githubUsername": "s0x" | ||
}, | ||
{ | ||
"name": "Weiyu Weng", | ||
"url": "https://github.com/pcdotfan", | ||
"githubUsername": "pcdotfan" | ||
} | ||
], | ||
"main": "", | ||
"types": "index", | ||
"types": "index.d.ts", | ||
"repository": { | ||
"type": "git", | ||
"url": "https://github.com/DefinitelyTyped/DefinitelyTyped.git" | ||
"url": "https://github.com/DefinitelyTyped/DefinitelyTyped.git", | ||
"directory": "types/uikit" | ||
}, | ||
"scripts": {}, | ||
"dependencies": { | ||
"@types/jquery": "*" | ||
}, | ||
"typesPublisherContentHash": "6825f0f3cae616baa183ac069dab2075271d207e5dc80eb497913ff50825bce1", | ||
"typeScriptVersion": "2.3" | ||
"dependencies": {}, | ||
"typesPublisherContentHash": "834dc836c812960106428af90d6d57a4065b01b207a6e3132fe2fbbc888554d1", | ||
"typeScriptVersion": "2.8" | ||
} |
@@ -5,13 +5,13 @@ # Installation | ||
# Summary | ||
This package contains type definitions for uikit ( https://getuikit.com ). | ||
This package contains type definitions for uikit (https://getuikit.com). | ||
# Details | ||
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/uikit | ||
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/uikit. | ||
Additional Details | ||
* Last updated: Thu, 14 Feb 2019 00:21:07 GMT | ||
* Dependencies: @types/jquery | ||
* Global values: UIkit | ||
### Additional Details | ||
* Last updated: Tue, 25 Feb 2020 22:06:35 GMT | ||
* Dependencies: none | ||
* Global values: none | ||
# Credits | ||
These definitions were written by Giovanni Silva <https://github.com/giovannicandido>, Ivo Senner <https://github.com/s0x>. | ||
These definitions were written by [Giovanni Silva](https://github.com/giovannicandido), [Ivo Senner](https://github.com/s0x), and [Weiyu Weng](https://github.com/pcdotfan). |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
0
18570
488
1
- Removed@types/jquery@*
- Removed@types/jquery@3.5.32(transitive)
- Removed@types/sizzle@2.3.9(transitive)