kdu-client-only 2.0.0 → 2.1.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.
Files changed (7) hide show
  1. package/LICENSE +21 -21
  2. package/README.md +93 -93
  3. package/dist/kdu-client-only.common.js +37 -37
  4. package/dist/kdu-client-only.js +37 -37
  5. package/dist/kdu-client-only.min.js +2 -2
  6. package/package.json +48 -41
  7. package/types/index.d.ts +10 -0
package/LICENSE CHANGED
@@ -1,21 +1,21 @@
1
- The MIT License (MIT)
2
-
3
- Copyright (c) 2022-present NKDuy
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
13
- all 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
21
- THE SOFTWARE.
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2022-present NKDuy
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
13
+ all 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
21
+ THE SOFTWARE.
package/README.md CHANGED
@@ -1,93 +1,93 @@
1
- # kdu-client-only
2
-
3
- ## Install
4
-
5
- ```bash
6
- yarn add kdu-client-only
7
- ```
8
-
9
- ## Usage
10
-
11
- ```kdu
12
- <template>
13
- <div id="app">
14
- <h1>My Website</h1>
15
- <client-only>
16
- <!-- this component will only be rendered on client-side -->
17
- <comments />
18
- </client-only>
19
- </div>
20
- </template>
21
-
22
- <script>
23
- import ClientOnly from 'kdu-client-only'
24
-
25
- export default {
26
- components: {
27
- ClientOnly
28
- }
29
- }
30
- </script>
31
- ```
32
-
33
- ### Placeholder
34
-
35
- Use a slot or text as placeholder until `<client-only />` is mounted on client-side.
36
-
37
- eg, show a loading indicator.
38
-
39
- ```kdu
40
- <template>
41
- <div id="app">
42
- <h1>My Website</h1>
43
- <!-- use slot -->
44
- <client-only>
45
- <comments />
46
-      <comments-placeholder slot="placeholder" />
47
-    </client-only>
48
- <!-- or use text -->
49
- <client-only placeholder="Loading...">
50
- <comments />
51
- </client-only>
52
- </div>
53
- </template>
54
-
55
- <script>
56
- import ClientOnly from 'kdu-client-only'
57
-
58
- export default {
59
- components: {
60
- ClientOnly
61
- }
62
- }
63
- </script>
64
- ```
65
-
66
- By default the placeholder will be wrapped in a `div` tag, however you can use `placeholderTag` prop to customize it:
67
-
68
- ```kdu
69
- <client-only placeholder="loading" placeholder-tag="span">
70
- <comments />
71
- </client-only>
72
- ```
73
-
74
- And you get:
75
-
76
- ```html
77
- <span class="client-only-placeholder">
78
- loading
79
- </span>
80
- ```
81
-
82
- If prop `placeholder` is an empty string (or `null`) and no `placeholder`
83
- slot is found, then `<client-only>` will render the Kdu placeholder element `<!---->`
84
- instead of rendering the `placholder-tag` during SSR render.
85
-
86
- ## Development
87
-
88
- ```bash
89
- yarn install
90
-
91
- # Run example
92
- yarn example
93
- ```
1
+ # kdu-client-only
2
+
3
+ ## Install
4
+
5
+ ```bash
6
+ yarn add kdu-client-only
7
+ ```
8
+
9
+ ## Usage
10
+
11
+ ```kdu
12
+ <template>
13
+ <div id="app">
14
+ <h1>My Website</h1>
15
+ <client-only>
16
+ <!-- this component will only be rendered on client-side -->
17
+ <comments />
18
+ </client-only>
19
+ </div>
20
+ </template>
21
+
22
+ <script>
23
+ import ClientOnly from 'kdu-client-only'
24
+
25
+ export default {
26
+ components: {
27
+ ClientOnly
28
+ }
29
+ }
30
+ </script>
31
+ ```
32
+
33
+ ### Placeholder
34
+
35
+ Use a slot or text as placeholder until `<client-only />` is mounted on client-side.
36
+
37
+ eg, show a loading indicator.
38
+
39
+ ```kdu
40
+ <template>
41
+ <div id="app">
42
+ <h1>My Website</h1>
43
+ <!-- use slot -->
44
+ <client-only>
45
+ <comments />
46
+      <comments-placeholder slot="placeholder" />
47
+    </client-only>
48
+ <!-- or use text -->
49
+ <client-only placeholder="Loading...">
50
+ <comments />
51
+ </client-only>
52
+ </div>
53
+ </template>
54
+
55
+ <script>
56
+ import ClientOnly from 'kdu-client-only'
57
+
58
+ export default {
59
+ components: {
60
+ ClientOnly
61
+ }
62
+ }
63
+ </script>
64
+ ```
65
+
66
+ By default the placeholder will be wrapped in a `div` tag, however you can use `placeholderTag` prop to customize it:
67
+
68
+ ```kdu
69
+ <client-only placeholder="loading" placeholder-tag="span">
70
+ <comments />
71
+ </client-only>
72
+ ```
73
+
74
+ And you get:
75
+
76
+ ```html
77
+ <span class="client-only-placeholder">
78
+ loading
79
+ </span>
80
+ ```
81
+
82
+ If prop `placeholder` is an empty string (or `null`) and no `placeholder`
83
+ slot is found, then `<client-only>` will render the Kdu placeholder element `<!---->`
84
+ instead of rendering the `placholder-tag` during SSR render.
85
+
86
+ ## Development
87
+
88
+ ```bash
89
+ yarn install
90
+
91
+ # Run example
92
+ yarn example
93
+ ```
package/dist/kdu-client-only.common.js CHANGED
@@ -1,51 +1,51 @@
1
1
  /*!
2
- * kdu-client-only v2.0.0
3
- * (c) 2022-present NKDuy
2
+ * kdu-client-only v2.1.0
3
+ * (c) 2026-present NKDuy
4
4
  * Released under the MIT License.
5
5
  */
6
6
  'use strict';
7
7
 
8
- var index = {
9
- name: 'ClientOnly',
10
- functional: true,
11
- props: {
12
- placeholder: String,
13
- placeholderTag: {
14
- type: String,
15
- default: 'div'
16
- }
17
- },
8
+ var index = {
9
+ name: 'ClientOnly',
10
+ functional: true,
11
+ props: {
12
+ placeholder: String,
13
+ placeholderTag: {
14
+ type: String,
15
+ default: 'div'
16
+ }
17
+ },
18
18
  render: function render(h, ref) {
19
19
  var parent = ref.parent;
20
20
  var slots = ref.slots;
21
21
  var props = ref.props;
22
-
22
+
23
23
  var ref$1 = slots();
24
24
  var defaultSlot = ref$1.default; if ( defaultSlot === void 0 ) defaultSlot = [];
25
- var placeholderSlot = ref$1.placeholder;
26
-
27
- if (parent._isMounted) {
28
- return defaultSlot
29
- }
30
-
31
- parent.$once('hook:mounted', function () {
32
- parent.$forceUpdate();
33
- });
34
-
35
- if (props.placeholderTag && (props.placeholder || placeholderSlot)) {
36
- return h(
37
- props.placeholderTag,
38
- {
39
- class: ['client-only-placeholder']
40
- },
41
- props.placeholder || placeholderSlot
42
- )
43
- }
44
-
45
- // Return a placeholder element for each child in the default slot
46
- // Or if no children return a single placeholder
47
- return defaultSlot.length > 0 ? defaultSlot.map(function () { return h(false); }) : h(false)
48
- }
25
+ var placeholderSlot = ref$1.placeholder;
26
+
27
+ if (parent._isMounted) {
28
+ return defaultSlot
29
+ }
30
+
31
+ parent.$once('hook:mounted', function () {
32
+ parent.$forceUpdate();
33
+ });
34
+
35
+ if (props.placeholderTag && (props.placeholder || placeholderSlot)) {
36
+ return h(
37
+ props.placeholderTag,
38
+ {
39
+ class: ['client-only-placeholder']
40
+ },
41
+ props.placeholder || placeholderSlot
42
+ )
43
+ }
44
+
45
+ // Return a placeholder element for each child in the default slot
46
+ // Or if no children return a single placeholder
47
+ return defaultSlot.length > 0 ? defaultSlot.map(function () { return h(false); }) : h(false)
48
+ }
49
49
  };
50
50
 
51
51
  module.exports = index;
package/dist/kdu-client-only.js CHANGED
@@ -1,6 +1,6 @@
1
1
  /*!
2
- * kdu-client-only v2.0.0
3
- * (c) 2022-present NKDuy
2
+ * kdu-client-only v2.1.0
3
+ * (c) 2026-present NKDuy
4
4
  * Released under the MIT License.
5
5
  */
6
6
  (function (global, factory) {
@@ -9,47 +9,47 @@
9
9
  (global.ClientOnly = factory());
10
10
  }(this, (function () { 'use strict';
11
11
 
12
- var index = {
13
- name: 'ClientOnly',
14
- functional: true,
15
- props: {
16
- placeholder: String,
17
- placeholderTag: {
18
- type: String,
19
- default: 'div'
20
- }
21
- },
12
+ var index = {
13
+ name: 'ClientOnly',
14
+ functional: true,
15
+ props: {
16
+ placeholder: String,
17
+ placeholderTag: {
18
+ type: String,
19
+ default: 'div'
20
+ }
21
+ },
22
22
  render: function render(h, ref) {
23
23
  var parent = ref.parent;
24
24
  var slots = ref.slots;
25
25
  var props = ref.props;
26
-
26
+
27
27
  var ref$1 = slots();
28
28
  var defaultSlot = ref$1.default; if ( defaultSlot === void 0 ) defaultSlot = [];
29
- var placeholderSlot = ref$1.placeholder;
30
-
31
- if (parent._isMounted) {
32
- return defaultSlot
33
- }
34
-
35
- parent.$once('hook:mounted', function () {
36
- parent.$forceUpdate();
37
- });
38
-
39
- if (props.placeholderTag && (props.placeholder || placeholderSlot)) {
40
- return h(
41
- props.placeholderTag,
42
- {
43
- class: ['client-only-placeholder']
44
- },
45
- props.placeholder || placeholderSlot
46
- )
47
- }
48
-
49
- // Return a placeholder element for each child in the default slot
50
- // Or if no children return a single placeholder
51
- return defaultSlot.length > 0 ? defaultSlot.map(function () { return h(false); }) : h(false)
52
- }
29
+ var placeholderSlot = ref$1.placeholder;
30
+
31
+ if (parent._isMounted) {
32
+ return defaultSlot
33
+ }
34
+
35
+ parent.$once('hook:mounted', function () {
36
+ parent.$forceUpdate();
37
+ });
38
+
39
+ if (props.placeholderTag && (props.placeholder || placeholderSlot)) {
40
+ return h(
41
+ props.placeholderTag,
42
+ {
43
+ class: ['client-only-placeholder']
44
+ },
45
+ props.placeholder || placeholderSlot
46
+ )
47
+ }
48
+
49
+ // Return a placeholder element for each child in the default slot
50
+ // Or if no children return a single placeholder
51
+ return defaultSlot.length > 0 ? defaultSlot.map(function () { return h(false); }) : h(false)
52
+ }
53
53
  };
54
54
 
55
55
  return index;
package/dist/kdu-client-only.min.js CHANGED
@@ -1,6 +1,6 @@
1
1
  /*!
2
- * kdu-client-only v2.0.0
3
- * (c) 2022-present NKDuy
2
+ * kdu-client-only v2.1.0
3
+ * (c) 2026-present NKDuy
4
4
  * Released under the MIT License.
5
5
  */
6
6
  !function(e,n){"object"==typeof exports&&"undefined"!=typeof module?module.exports=n():"function"==typeof define&&define.amd?define(n):e.ClientOnly=n()}(this,function(){"use strict";return{name:"ClientOnly",functional:!0,props:{placeholder:String,placeholderTag:{type:String,default:"div"}},render:function(e,n){var o=n.parent,t=n.slots,l=n.props,r=t(),d=r.default;void 0===d&&(d=[]);var a=r.placeholder;return o._isMounted?d:(o.$once("hook:mounted",function(){o.$forceUpdate()}),l.placeholderTag&&(l.placeholder||a)?e(l.placeholderTag,{class:["client-only-placeholder"]},l.placeholder||a):d.length>0?d.map(function(){return e(!1)}):e(!1))}}});
package/package.json CHANGED
@@ -1,41 +1,48 @@
1
- {
2
- "name": "kdu-client-only",
3
- "version": "2.0.0",
4
- "description": "kdu component to wrap non SSR friendly components",
5
- "repository": {
6
- "url": "khanhduy1407/kdu-client-only",
7
- "type": "git"
8
- },
9
- "main": "dist/kdu-client-only.common.js",
10
- "unpkg": "dist/kdu-client-only.min.js",
11
- "files": [
12
- "dist"
13
- ],
14
- "scripts": {
15
- "lint": "xo",
16
- "build": "npm run build:cjs && npm run build:umd",
17
- "build:cjs": "bili --format cjs",
18
- "build:umd": "bili --format umd --compress",
19
- "prepublish": "npm run build",
20
- "example": "poi"
21
- },
22
- "poi": {
23
- "entry": "example/index.js",
24
- "dist": "example/dist"
25
- },
26
- "author": "NKDuy",
27
- "license": "MIT",
28
- "dependencies": {},
29
- "devDependencies": {
30
- "bili": "^0.16.0-rc.1",
31
- "eslint-config-rem": "^3.0.0",
32
- "poi": "^9.3.1",
33
- "xo": "^0.18.0"
34
- },
35
- "xo": {
36
- "extends": "rem/prettier",
37
- "ignores": [
38
- "example/**"
39
- ]
40
- }
41
- }
1
+ {
2
+ "name": "kdu-client-only",
3
+ "version": "2.1.0",
4
+ "description": "kdu component to wrap non SSR friendly components",
5
+ "repository": {
6
+ "url": "khanhduy1407/kdu-client-only",
7
+ "type": "git"
8
+ },
9
+ "main": "dist/kdu-client-only.common.js",
10
+ "unpkg": "dist/kdu-client-only.min.js",
11
+ "types": "types/index.d.ts",
12
+ "files": [
13
+ "dist",
14
+ "types/index.d.ts"
15
+ ],
16
+ "scripts": {
17
+ "types": "dtslint --localTs node_modules/typescript/lib types",
18
+ "lint": "xo",
19
+ "build": "npm run build:cjs && npm run build:umd",
20
+ "build:cjs": "bili --format cjs",
21
+ "build:umd": "bili --format umd --compress",
22
+ "prepublish": "npm run build",
23
+ "example": "poi"
24
+ },
25
+ "poi": {
26
+ "entry": "example/index.js",
27
+ "dist": "example/dist"
28
+ },
29
+ "author": "NKDuy",
30
+ "license": "MIT",
31
+ "dependencies": {},
32
+ "devDependencies": {
33
+ "bili": "^0.16.0-rc.1",
34
+ "dtslint": "^4.1.0",
35
+ "eslint-config-rem": "^3.0.0",
36
+ "kdu": "^2.6.14",
37
+ "poi": "^9.3.1",
38
+ "tsd": "^0.16.0",
39
+ "typescript": "^4.3.2",
40
+ "xo": "^0.18.0"
41
+ },
42
+ "xo": {
43
+ "extends": "rem/prettier",
44
+ "ignores": [
45
+ "example/**"
46
+ ]
47
+ }
48
+ }
package/types/index.d.ts ADDED
@@ -0,0 +1,10 @@
1
+ import { FunctionalComponentOptions } from 'kdu';
2
+
3
+ export interface ClientOnlyProps {
4
+ placeholder?: string;
5
+ placeholderTag?: string;
6
+ }
7
+
8
+ declare const ClientOnly: FunctionalComponentOptions<ClientOnlyProps>;
9
+
10
+ export default ClientOnly;