minisnackbar 2.0.0 → 3.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -21
- package/README.md +33 -19
- package/dist/constants.d.ts +10 -0
- package/dist/constants.d.ts.map +1 -0
- package/dist/controller.d.ts +27 -0
- package/dist/controller.d.ts.map +1 -0
- package/dist/index.d.ts +3 -33
- package/dist/index.d.ts.map +1 -1
- package/dist/minisnackbar.cjs +406 -357
- package/dist/minisnackbar.cjs.map +1 -1
- package/dist/minisnackbar.esm.js +372 -317
- package/dist/minisnackbar.esm.js.map +1 -1
- package/dist/minisnackbar.js +420 -367
- package/dist/minisnackbar.js.map +1 -1
- package/dist/minisnackbar.min.js +11 -10
- package/dist/minisnackbar.min.js.map +1 -1
- package/dist/renderer.d.ts +18 -0
- package/dist/renderer.d.ts.map +1 -0
- package/dist/styles.d.ts +4 -0
- package/dist/styles.d.ts.map +1 -0
- package/dist/types.d.ts +14 -0
- package/dist/types.d.ts.map +1 -0
- package/dist/validation.d.ts +6 -0
- package/dist/validation.d.ts.map +1 -0
- package/docs.md +514 -0
- package/package.json +64 -63
- package/dist/minisnackbar.min.cjs +0 -12
- package/dist/minisnackbar.min.cjs.map +0 -1
package/LICENSE
CHANGED
|
@@ -1,21 +1,21 @@
|
|
|
1
|
-
MIT License
|
|
2
|
-
|
|
3
|
-
Copyright (c) 2025 MiniSnackbar
|
|
4
|
-
|
|
5
|
-
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
-
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
-
in the Software without restriction, including without limitation the rights
|
|
8
|
-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
-
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
-
furnished to do so, subject to the following conditions:
|
|
11
|
-
|
|
12
|
-
The above copyright notice and this permission notice shall be included in all
|
|
13
|
-
copies or substantial portions of the Software.
|
|
14
|
-
|
|
15
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
-
SOFTWARE.
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 MiniSnackbar
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -2,13 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
 
|
|
4
4
|
|
|
5
|
-
A simple, lightweight
|
|
5
|
+
A simple, lightweight snackbar/toast library with no dependencies. Works standalone or seamlessly blends with [Material Web](https://material-web.dev/) components, adapting to your site's theme when available. Since Material Web doesn't provide a snackbar component, this library fills that gap.
|
|
6
6
|
|
|
7
|
-
|
|
8
|
-
**License:** MIT
|
|
9
|
-
**Repository:** [github.com/shantoislamdev/minisnackbar](https://github.com/shantoislamdev/minisnackbar)
|
|
10
|
-
|
|
11
|
-
## Installation
|
|
7
|
+
## Install
|
|
12
8
|
|
|
13
9
|
```bash
|
|
14
10
|
npm install minisnackbar
|
|
@@ -17,29 +13,47 @@ npm install minisnackbar
|
|
|
17
13
|
## Usage
|
|
18
14
|
|
|
19
15
|
```javascript
|
|
20
|
-
// ES Module
|
|
21
16
|
import { Snackbar } from 'minisnackbar'
|
|
22
17
|
|
|
23
|
-
// CommonJS
|
|
24
|
-
const { Snackbar } = require('minisnackbar')
|
|
25
|
-
|
|
26
|
-
// Initialize
|
|
27
18
|
Snackbar.init()
|
|
19
|
+
Snackbar.add('Saved successfully')
|
|
28
20
|
|
|
29
|
-
|
|
30
|
-
|
|
21
|
+
Snackbar.add('Item deleted', {
|
|
22
|
+
text: 'UNDO',
|
|
23
|
+
handler: () => restoreItem()
|
|
24
|
+
})
|
|
31
25
|
```
|
|
32
26
|
|
|
33
|
-
##
|
|
27
|
+
## CDN
|
|
28
|
+
|
|
29
|
+
```html
|
|
30
|
+
<script src="https://unpkg.com/minisnackbar@3.0.0/dist/minisnackbar.min.js"></script>
|
|
31
|
+
<script>
|
|
32
|
+
Snackbar.init()
|
|
33
|
+
Snackbar.add('Hello from MiniSnackbar')
|
|
34
|
+
</script>
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
## API
|
|
38
|
+
|
|
39
|
+
- `Snackbar.init(options?)`
|
|
40
|
+
- `Snackbar.add(message, action?, duration?)`
|
|
41
|
+
- `Snackbar.show(message, action?, duration?)`
|
|
42
|
+
- `Snackbar.clearQueue()`
|
|
43
|
+
- `Snackbar.hideCurrent()`
|
|
44
|
+
- `Snackbar.destroy()`
|
|
45
|
+
- `Snackbar.isInitialized()`
|
|
46
|
+
|
|
47
|
+
## Builds
|
|
34
48
|
|
|
35
|
-
-
|
|
36
|
-
-
|
|
37
|
-
-
|
|
38
|
-
-
|
|
49
|
+
- ESM: `dist/minisnackbar.esm.js`
|
|
50
|
+
- CommonJS: `dist/minisnackbar.cjs`
|
|
51
|
+
- Browser global: `dist/minisnackbar.min.js`
|
|
52
|
+
- Types: `dist/index.d.ts`
|
|
39
53
|
|
|
40
54
|
## Documentation
|
|
41
55
|
|
|
42
|
-
|
|
56
|
+
See [docs.md](docs.md) for configuration, styling, and advanced usage.
|
|
43
57
|
|
|
44
58
|
## License
|
|
45
59
|
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
export declare const SNACKBAR_ID = "mini-snackbar";
|
|
2
|
+
export declare const STYLES_ID = "mini-snackbar-styles";
|
|
3
|
+
export declare const SNACKBAR_CLASS = "mini-snackbar";
|
|
4
|
+
export declare const SNACKBAR_VISIBLE_CLASS = "show";
|
|
5
|
+
export declare const SNACKBAR_TEXT_CLASS = "mini-snackbar-text";
|
|
6
|
+
export declare const SNACKBAR_ACTION_CLASS = "mini-snackbar-action";
|
|
7
|
+
export declare const DEFAULT_DURATION = 3000;
|
|
8
|
+
export declare const DEFAULT_TRANSITION_DURATION = 250;
|
|
9
|
+
export declare const QUEUE_GAP_DURATION = 200;
|
|
10
|
+
//# sourceMappingURL=constants.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,WAAW,kBAAkB,CAAA;AAC1C,eAAO,MAAM,SAAS,yBAAyB,CAAA;AAE/C,eAAO,MAAM,cAAc,kBAAkB,CAAA;AAC7C,eAAO,MAAM,sBAAsB,SAAS,CAAA;AAC5C,eAAO,MAAM,mBAAmB,uBAAuB,CAAA;AACvD,eAAO,MAAM,qBAAqB,yBAAyB,CAAA;AAE3D,eAAO,MAAM,gBAAgB,OAAO,CAAA;AACpC,eAAO,MAAM,2BAA2B,MAAM,CAAA;AAC9C,eAAO,MAAM,kBAAkB,MAAM,CAAA"}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import type { SnackbarItem, SnackbarOptions } from './types';
|
|
2
|
+
export declare class SnackbarController {
|
|
3
|
+
private queue;
|
|
4
|
+
private state;
|
|
5
|
+
private renderer;
|
|
6
|
+
private displayTimer;
|
|
7
|
+
private transitionTimer;
|
|
8
|
+
private queueGapTimer;
|
|
9
|
+
private transitionDuration;
|
|
10
|
+
private initialized;
|
|
11
|
+
init(options?: SnackbarOptions): void;
|
|
12
|
+
destroy(): void;
|
|
13
|
+
add(message: string, action?: SnackbarItem['action'], duration?: number): void;
|
|
14
|
+
show(message: string, action?: SnackbarItem['action'], duration?: number): void;
|
|
15
|
+
clearQueue(): void;
|
|
16
|
+
hideCurrent(): void;
|
|
17
|
+
isInitialized(): boolean;
|
|
18
|
+
getTransitionDuration(): number;
|
|
19
|
+
private showNext;
|
|
20
|
+
private showItem;
|
|
21
|
+
private hideActiveItem;
|
|
22
|
+
private finishCurrentItem;
|
|
23
|
+
private ensureInitialized;
|
|
24
|
+
private clearTimers;
|
|
25
|
+
private clearTimer;
|
|
26
|
+
}
|
|
27
|
+
//# sourceMappingURL=controller.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"controller.d.ts","sourceRoot":"","sources":["../src/controller.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,eAAe,EAAiB,MAAM,SAAS,CAAA;AAG3E,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,KAAK,CAAqB;IAClC,OAAO,CAAC,KAAK,CAAwB;IACrC,OAAO,CAAC,QAAQ,CAAgC;IAChD,OAAO,CAAC,YAAY,CAA6C;IACjE,OAAO,CAAC,eAAe,CAA6C;IACpE,OAAO,CAAC,aAAa,CAA6C;IAClE,OAAO,CAAC,kBAAkB,CAA8B;IACxD,OAAO,CAAC,WAAW,CAAQ;IAE3B,IAAI,CAAC,OAAO,GAAE,eAAoB,GAAG,IAAI;IAqBzC,OAAO,IAAI,IAAI;IAUf,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,GAAE,YAAY,CAAC,QAAQ,CAAQ,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI;IAUpF,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,GAAE,YAAY,CAAC,QAAQ,CAAQ,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI;IAuBrF,UAAU,IAAI,IAAI;IAKlB,WAAW,IAAI,IAAI;IAMnB,aAAa,IAAI,OAAO;IAIxB,qBAAqB,IAAI,MAAM;IAI/B,OAAO,CAAC,QAAQ;IAShB,OAAO,CAAC,QAAQ;IAoBhB,OAAO,CAAC,cAAc;IAetB,OAAO,CAAC,iBAAiB;IAWzB,OAAO,CAAC,iBAAiB;IAMzB,OAAO,CAAC,WAAW;IAMnB,OAAO,CAAC,UAAU;CAKnB"}
|
package/dist/index.d.ts
CHANGED
|
@@ -1,54 +1,24 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* MiniSnackbar - A simple vanilla JavaScript snackbar/toast library
|
|
3
3
|
*
|
|
4
|
-
* @version
|
|
4
|
+
* @version 3.0.0
|
|
5
5
|
* @author Shanto Islam <shantoislamdev@gmail.com>
|
|
6
6
|
* @license MIT
|
|
7
7
|
* @description A lightweight, zero-dependency snackbar library with Material Design integration
|
|
8
8
|
* @repository https://github.com/shantoislamdev/minisnackbar
|
|
9
9
|
* @homepage https://github.com/shantoislamdev/minisnackbar#readme
|
|
10
10
|
*/
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
handler: () => void;
|
|
14
|
-
}
|
|
15
|
-
export interface SnackbarOptions {
|
|
16
|
-
transitionDuration?: number;
|
|
17
|
-
}
|
|
18
|
-
export interface SnackbarItem {
|
|
19
|
-
message: string;
|
|
20
|
-
action: SnackbarAction | null;
|
|
21
|
-
duration: number;
|
|
22
|
-
}
|
|
23
|
-
type SnackbarState = 'idle' | 'showing' | 'transitioning';
|
|
11
|
+
import type { SnackbarAction, SnackbarOptions } from './types';
|
|
12
|
+
export type { SnackbarAction, SnackbarOptions };
|
|
24
13
|
declare class Snackbar {
|
|
25
|
-
private static _queue;
|
|
26
|
-
private static _isShowing;
|
|
27
|
-
private static _currentTimeout;
|
|
28
|
-
private static _state;
|
|
29
|
-
private static _currentActionHandler;
|
|
30
|
-
private static _transitionDuration;
|
|
31
|
-
private static _initialized;
|
|
32
14
|
static init(options?: SnackbarOptions): void;
|
|
33
15
|
static destroy(): void;
|
|
34
16
|
static getTransitionDuration(): number;
|
|
35
17
|
static add(message: string, action?: SnackbarAction | null, duration?: number): void;
|
|
36
|
-
private static _cleanupAction;
|
|
37
|
-
private static _showSnackbar;
|
|
38
|
-
private static _hideSnackbar;
|
|
39
18
|
static show(message: string, action?: SnackbarAction | null, duration?: number): void;
|
|
40
|
-
static showNext(): void;
|
|
41
19
|
static clearQueue(): void;
|
|
42
20
|
static hideCurrent(): void;
|
|
43
21
|
static isInitialized(): boolean;
|
|
44
|
-
static get queue(): SnackbarItem[];
|
|
45
|
-
static set queue(value: SnackbarItem[]);
|
|
46
|
-
static get isShowing(): boolean;
|
|
47
|
-
static set isShowing(value: boolean);
|
|
48
|
-
static get currentTimeout(): ReturnType<typeof setTimeout> | null;
|
|
49
|
-
static set currentTimeout(value: ReturnType<typeof setTimeout> | null);
|
|
50
|
-
static get state(): SnackbarState;
|
|
51
|
-
static set state(value: SnackbarState);
|
|
52
22
|
}
|
|
53
23
|
export default Snackbar;
|
|
54
24
|
export { Snackbar };
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAGH,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAGH,OAAO,KAAK,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA;AAE9D,YAAY,EAAE,cAAc,EAAE,eAAe,EAAE,CAAA;AAI/C,cAAM,QAAQ;IACZ,MAAM,CAAC,IAAI,CAAC,OAAO,GAAE,eAAoB,GAAG,IAAI;IAIhD,MAAM,CAAC,OAAO,IAAI,IAAI;IAItB,MAAM,CAAC,qBAAqB,IAAI,MAAM;IAItC,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,GAAE,cAAc,GAAG,IAAW,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI;IAI1F,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,GAAE,cAAc,GAAG,IAAW,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI;IAI3F,MAAM,CAAC,UAAU,IAAI,IAAI;IAIzB,MAAM,CAAC,WAAW,IAAI,IAAI;IAI1B,MAAM,CAAC,aAAa,IAAI,OAAO;CAGhC;AAED,eAAe,QAAQ,CAAA;AACvB,OAAO,EAAE,QAAQ,EAAE,CAAA"}
|