This item has been migrated to easy-dom
中文 | Version Log | Online use
[TOC]
npm i tacl-ui
use
import {tool, toast, confirm, alert, loading, drag} from'tacl-ui';
// or
import TaclUI from'tacl-ui';
// TaclUI = {tool, toast, confirm, alert, loading, drag}
// do something ...<script src="https://cdn.jsdelivr.net/npm/tacl-ui/taclui.min.js"></script>
<!-- or -->
<!-- <script src="https://cdn.jsdelivr.net/npm/tacl-ui@x.x.x/taclui.min.js"></script> -->
<script>
TaclUI.toast('Hello world!')
</script>Expose the easy-dom tool
Pop up a toast
// simple call
toast(text[, time, position]);
toast('a hint')
// json call
toast({
text:'A prompt',
// Other parameters
})
// new method All components in tacl are an instance by default, you can use the new method to create a new instance
const close = toast.new(...);parameter list
declare interface ToasterOpts {
text?: string;
time?: number;
position?:'top'|'middle'|'bottom';
parent?: DomEle;
onhide?(): void;
onopen?(): void;
contentHtml?: boolean;
showClose?: boolean;
customClass?: string;
button?: {// add a small button
text: string;
onclick(): void;
}
}A confirm confirmation box pops up
// simple call
confirm('Whether to confirm')
confirm('whether to confirm','confirm box')
// json call
confirm({
text:'Are you sure?',
title:'Confirmation box',
confirmText:'confirm',
cancelText:'cancel',
cancelBtn:false, // Do you need a cancel button
theme:'default', //
}).then((result)=>{
if (result) {
} else {
}
})
// new
confirm.new(...).then((result)=>{})parameter list
declare interface ConfirmerOpts {
text?:string;
title?:string;
confirmText?:string;
cancelText?:string;
cancelBtn?:boolean;
closeBtn?:boolean;
parent?: DomEle;
theme?: confirmStyle;
onhide?(): void;
onopen?(): void;
customEl?: DomEle;
customClass?: string;
contentHtml?: boolean; // default false
custom?(box: Ele, $: ToolStatic): void;
type?: confirmType; // default confirmType.confirm
onGetCloseMethod?(fn: void): void; // Get the closed function when user new creates a new pop-up box
clickConfirmClose?: boolean; // default true
clickCancelClose?: boolean; // default true
onconfirm?(): void;
oncancel?(): void;
}enumerate
declare type confirmResultType ='confirm' |'cancel' |'close';
declare type confirmType ='confirm' |'alert' |'pop';
declare type confirmStyle ='yellow2' |'yellow' |'default';Pop up an alert
// simple call
alert('success')
alert('success','success title')
// json call
alert({
text:'Success',
title:'Success Title',
confirmText:'confirm',
theme:'default', //
}).then(()=>{
})
// new
alert.new(...).then((result)=>{})parameter list
Same as confirm
Pop up a pop-up box
// simple call
pop('Are you sure?')
pop('Are you sure?','Confirmation box')
// json call
pop({
text:'Are you sure?',
title:'Confirmation box',
confirmText:'confirm',
cancelText:'cancel',
cancelBtn:false, // Do you need a cancel button
theme:'default', //
}).then((result)=>{
if (result) {
} else {
}
})
// new
pop.new(...).then((result)=>{})parameter list
Same as confirm
Pop up a loading
// simple call
loading(text[,time]);
loading();
loading('Loading...');
loading('Loading...', 1000);
loading.close(); // Manually close
// json call
loading({
text:'Success',
time:1000
})
const close = loading.new(...);parameter list
declare interface LoadingerOpts {
text?:string;
time?:number|null;
parent?: DomEle;
backgroundOpacity?: number;
onopen?(): void;
onhide?(): void;
}Generate a draggable element, compatible with pc and mobile
let el = drag({
el,
parent,
enableDrag = true,
onClick = df,
onSideChange = df,
zIndex = 100,
aside = false,
preventDefault = true,
reinitPosition = false,
margin = 3, // upper right lower left or just pass in a number
})parameter list
| Parameter | Must | Type | Default Value | Description |
|---|---|---|---|---|
| el | Yes | dom/Ele/selector | - | Elements to be dragged |
| parent | No | dom/Ele/selector | - | Specify a parent element, so that the drag can only be carried out in the parent element, and the parent element needs to set the position style |
| enableDrag | No | boolean | true | Whether it can be dragged or not |
| onClick | No | function | function(){} | Click event |
| aside | no | boolean | false | whether to be adsorbed on both sides |
| onSideChange | No | function | function(isLeft){} | Only takes effect when aside=true, and triggers when the suction side changes |
| zIndex | No | number | 100 | z-index of the dragged element |
| preventDefault | No | boolean | true | Whether to prohibit the default event behavior |
| margin | No | number/Array[top,right/bottom/left] | 3 | Top, bottom, left, and right margins |
| reinitPosition | No | boolean | false | Whether to change the position of the drag according to the orientationchange and resize events, it needs to be turned on when the drag is full screen |
declare interface DragParameters {
el: Ele|HTMLElement|string;
parent?: Ele|HTMLElement|string;
onClick?: (event: Event, endX: number, endY: number) => {};
onSideChange?: (isLeft:boolean) => {};
zIndex?: number;
enableDrag?:boolean;
delay?:number;
aside?:boolean;
preventDefault?:boolean;
reinitPosition?:boolean;
margin?:number|Array<number>;
onDragStart?: (event: Event, x: number, y: number) => {};
onDragMove?: (event: Event, x: number, y: number) => {};
onDragEnd?: (event: Event, x: number, y: number) => {};
}
declare class Drag {
constructor(parameters: DragParameters);
setPosition(left: number, top: number): void;
initPosition(): void;
getParentSize(): {width: number, height: number};
aside: boolean;
sideLeft: boolean;
enableDrag: boolean;
preventDefault: boolean;
left: number|string;
top: number|string;
margin: Array<number>;
}Remarks: Regarding preventDefault, preventDefault=true can prohibit the dragging of the browser on the mobile terminal to cause the page to move, and there is a blank at the top But this attribute will also prohibit the click event of the child element, which can be circumvented by the target attribute of the event in the onClick event Both methods have their pros and cons
Attribute list
preventDefault, enableDrag, aside
The use is the same as the parameter list, and the properties can be dynamically modified after generation