@jump-section/vue 1.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/dist/index.d.mts +38 -0
- package/dist/index.d.ts +38 -0
- package/dist/index.js +1 -0
- package/dist/index.mjs +1 -0
- package/package.json +40 -0
package/dist/index.d.mts
ADDED
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
import * as vue from 'vue';
|
|
2
|
+
import { PropType } from 'vue';
|
|
3
|
+
import { ScrollOptions, ScrollManager } from '@jump-section/core';
|
|
4
|
+
|
|
5
|
+
declare function provideScrollManager(options?: ScrollOptions): ScrollManager;
|
|
6
|
+
declare function useScrollManager(): ScrollManager;
|
|
7
|
+
declare function useScrollSection(sectionId?: string): {
|
|
8
|
+
registerRef: (element: Element | undefined) => void;
|
|
9
|
+
scrollTo: (id: string) => void;
|
|
10
|
+
activeId: Readonly<vue.Ref<string | null, string | null>>;
|
|
11
|
+
isActive: boolean;
|
|
12
|
+
};
|
|
13
|
+
declare const ScrollSectionProvider: vue.DefineComponent<vue.ExtractPropTypes<{
|
|
14
|
+
offset: {
|
|
15
|
+
type: NumberConstructor;
|
|
16
|
+
default: number;
|
|
17
|
+
};
|
|
18
|
+
behavior: {
|
|
19
|
+
type: PropType<ScrollBehavior>;
|
|
20
|
+
default: string;
|
|
21
|
+
};
|
|
22
|
+
}>, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
|
|
23
|
+
[key: string]: any;
|
|
24
|
+
}>[] | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
|
|
25
|
+
offset: {
|
|
26
|
+
type: NumberConstructor;
|
|
27
|
+
default: number;
|
|
28
|
+
};
|
|
29
|
+
behavior: {
|
|
30
|
+
type: PropType<ScrollBehavior>;
|
|
31
|
+
default: string;
|
|
32
|
+
};
|
|
33
|
+
}>> & Readonly<{}>, {
|
|
34
|
+
offset: number;
|
|
35
|
+
behavior: ScrollBehavior;
|
|
36
|
+
}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
|
|
37
|
+
|
|
38
|
+
export { ScrollSectionProvider, provideScrollManager, useScrollManager, useScrollSection };
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
import * as vue from 'vue';
|
|
2
|
+
import { PropType } from 'vue';
|
|
3
|
+
import { ScrollOptions, ScrollManager } from '@jump-section/core';
|
|
4
|
+
|
|
5
|
+
declare function provideScrollManager(options?: ScrollOptions): ScrollManager;
|
|
6
|
+
declare function useScrollManager(): ScrollManager;
|
|
7
|
+
declare function useScrollSection(sectionId?: string): {
|
|
8
|
+
registerRef: (element: Element | undefined) => void;
|
|
9
|
+
scrollTo: (id: string) => void;
|
|
10
|
+
activeId: Readonly<vue.Ref<string | null, string | null>>;
|
|
11
|
+
isActive: boolean;
|
|
12
|
+
};
|
|
13
|
+
declare const ScrollSectionProvider: vue.DefineComponent<vue.ExtractPropTypes<{
|
|
14
|
+
offset: {
|
|
15
|
+
type: NumberConstructor;
|
|
16
|
+
default: number;
|
|
17
|
+
};
|
|
18
|
+
behavior: {
|
|
19
|
+
type: PropType<ScrollBehavior>;
|
|
20
|
+
default: string;
|
|
21
|
+
};
|
|
22
|
+
}>, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
|
|
23
|
+
[key: string]: any;
|
|
24
|
+
}>[] | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
|
|
25
|
+
offset: {
|
|
26
|
+
type: NumberConstructor;
|
|
27
|
+
default: number;
|
|
28
|
+
};
|
|
29
|
+
behavior: {
|
|
30
|
+
type: PropType<ScrollBehavior>;
|
|
31
|
+
default: string;
|
|
32
|
+
};
|
|
33
|
+
}>> & Readonly<{}>, {
|
|
34
|
+
offset: number;
|
|
35
|
+
behavior: ScrollBehavior;
|
|
36
|
+
}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
|
|
37
|
+
|
|
38
|
+
export { ScrollSectionProvider, provideScrollManager, useScrollManager, useScrollSection };
|
package/dist/index.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
'use strict';var vue=require('vue'),core=require('@jump-section/core');var a=Symbol("ScrollManager");function p(e={}){let r=new core.ScrollManager(e);return vue.provide(a,r),vue.onUnmounted(()=>{r.destroy();}),r}function m(){let e=vue.inject(a);if(!e)throw new Error("useScrollManager must be used within a component that calls provideScrollManager");return e}function y(e){let r=m(),n=vue.ref(null),t;return vue.onMounted(()=>{t=r.onActiveChange(o=>{n.value=o;});}),vue.onUnmounted(()=>{t&&t();}),{registerRef:o=>{o&&e?r.registerSection(e,o):e&&r.unregisterSection(e);},scrollTo:o=>r.scrollTo(o),activeId:vue.readonly(n),isActive:e?n.value===e:false}}var x=vue.defineComponent({name:"ScrollSectionProvider",props:{offset:{type:Number,default:0},behavior:{type:String,default:"smooth"}},setup(e,{slots:r}){return p({offset:e.offset,behavior:e.behavior}),()=>r.default?r.default():null}});exports.ScrollSectionProvider=x;exports.provideScrollManager=p;exports.useScrollManager=m;exports.useScrollSection=y;
|
package/dist/index.mjs
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
import {defineComponent,provide,onUnmounted,inject,ref,readonly,onMounted}from'vue';import {ScrollManager}from'@jump-section/core';var a=Symbol("ScrollManager");function p(e={}){let r=new ScrollManager(e);return provide(a,r),onUnmounted(()=>{r.destroy();}),r}function m(){let e=inject(a);if(!e)throw new Error("useScrollManager must be used within a component that calls provideScrollManager");return e}function y(e){let r=m(),n=ref(null),t;return onMounted(()=>{t=r.onActiveChange(o=>{n.value=o;});}),onUnmounted(()=>{t&&t();}),{registerRef:o=>{o&&e?r.registerSection(e,o):e&&r.unregisterSection(e);},scrollTo:o=>r.scrollTo(o),activeId:readonly(n),isActive:e?n.value===e:false}}var x=defineComponent({name:"ScrollSectionProvider",props:{offset:{type:Number,default:0},behavior:{type:String,default:"smooth"}},setup(e,{slots:r}){return p({offset:e.offset,behavior:e.behavior}),()=>r.default?r.default():null}});export{x as ScrollSectionProvider,p as provideScrollManager,m as useScrollManager,y as useScrollSection};
|
package/package.json
ADDED
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@jump-section/vue",
|
|
3
|
+
"version": "1.0.0",
|
|
4
|
+
"description": "Vue composables for jump-section scroll management",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"scroll",
|
|
7
|
+
"navigation",
|
|
8
|
+
"section",
|
|
9
|
+
"jump",
|
|
10
|
+
"vue",
|
|
11
|
+
"composables"
|
|
12
|
+
],
|
|
13
|
+
"repository": {
|
|
14
|
+
"type": "git",
|
|
15
|
+
"url": "git+https://github.com/bae080311/jump-section.git",
|
|
16
|
+
"directory": "packages/vue"
|
|
17
|
+
},
|
|
18
|
+
"license": "ISC",
|
|
19
|
+
"author": "k_jin.0",
|
|
20
|
+
"main": "dist/index.js",
|
|
21
|
+
"module": "dist/index.mjs",
|
|
22
|
+
"types": "dist/index.d.ts",
|
|
23
|
+
"sideEffects": false,
|
|
24
|
+
"files": [
|
|
25
|
+
"dist"
|
|
26
|
+
],
|
|
27
|
+
"dependencies": {
|
|
28
|
+
"@jump-section/core": "workspace:*"
|
|
29
|
+
},
|
|
30
|
+
"scripts": {
|
|
31
|
+
"build": "tsup",
|
|
32
|
+
"test": "vitest run --environment jsdom"
|
|
33
|
+
},
|
|
34
|
+
"peerDependencies": {
|
|
35
|
+
"vue": "^3.0.0"
|
|
36
|
+
},
|
|
37
|
+
"publishConfig": {
|
|
38
|
+
"access": "public"
|
|
39
|
+
}
|
|
40
|
+
}
|