README.md

SveltBorya

SvelteBorya is an unofficial project aimed at reimplementing VueUse with Svelte 5.

Note

Please note that my primary purpose is for learning.

Progress

State

• createGlobalState
• createInjectionState
• createSharedComposable
• injectLocal
• provideLocal
• useAsyncState
• useDebouncedRefHistory
• useLastChanged
• useLocalStorage
• useManualRefHistory
• useRefHistory
• useSessionStorage
• useStorage
• useStorageAsync
• useThrottledRefHistory

Browser

• useBluetooth
• useBreakpoints
• useBroadcastChannel
• useBrowserLocation
• useClipboard
• useClipboardItems
• useColorMode
• useCssVar
• useDark
• useEventListener
• useEyeDropper
• useFavicon
• useFileDialog
• useFileSystemAccess
• useFullscreen
• useGamepad
• useImage
• useMediaControls
• useMediaQuery
• useMemory
• useObjectUrl
• usePerformanceObserver
• usePermission
• usePreferredColorScheme
• usePreferredContrast
• usePreferredDark
• usePreferredLanguages
• usePreferredReducedMotion
• useScreenOrientation
• useScreenSafeArea
• useScriptTag
• useShare
• useStyleTag
• useTextareaAutosize
• useTextDirection
• useTitle
• useUrlSearchParams
• useVibrate
• useWakeLock
• useWebNotification
• useWebWorker
• useWebWorkerFn

Animation

• useAnimate
• useInterval
• useIntervalFn
• useNow
• useRafFn
• useTimeout
• useTimeoutFn
• useTimestamp
• useTransition

Component

• computedInject
• createReusableTemplate
• createTemplatePromise
• templateRef
• tryOnBeforeMount
• tryOnBeforeUnmount
• tryOnMounted
• tryOnScopeDispose
• tryOnUnmounted
• unrefElement
• useCurrentElement
• useMounted
• useTemplateRefsList
• useVirtualList
• useVModel
• useVModels

Utilities

• createEventHook
• createUnrefFn
• get
• isDefined
• makeDestructurable
• set
• useAsyncQueue
• useBase64
• useCached
• useCloned
• useConfirmDialog
• useCounter
• useCycleList
• useDebounceFn
• useEventBus
• useMemoize
• useOffsetPagination
• usePrevious
• useStepper
• useSupported
• useThrottleFn
• useTimeoutPoll
• useToggle
• useToNumber
• useToString

Developing

Once you've created a project and installed dependencies with npm install (or pnpm install or yarn), start a development server:

npm run dev
# or start the server and open the app in a new browser tab
npm run dev -- --open

Everything inside src/lib is part of your library, everything inside src/routes can be used as a showcase or preview app.

To create a production version of your showcase app:

npm run build

You can preview the production build with npm run preview.