Skip to content

Commit

Permalink
[feat](docs): update all docs URL to svelteui.dev
Browse files Browse the repository at this point in the history
  • Loading branch information
BeeMargarida committed Feb 12, 2024
1 parent cd7fd19 commit a854d0c
Show file tree
Hide file tree
Showing 89 changed files with 111 additions and 111 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/docs_report.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Report an issue with svelteui.org website
name: Report an issue with svelteui.dev website
description: Nothing is perfect, especially these docs, help us find and fix mistakes, bad wording, etc.
body:
- type: markdown
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ jobs:
run: |
yarn build:docs
touch apps/docs/build/.nojekyll
touch apps/docs/build/CNAME && echo 'www.svelteui.org' > apps/docs/build/CNAME
touch apps/docs/build/CNAME && echo 'www.svelteui.dev' > apps/docs/build/CNAME
- name: Upload Artifacts
uses: actions/upload-pages-artifact@v1
Expand Down
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<p align="center">
SvelteUI is an all inclusive Svelte library - Components, Actions, Utilities, Animations <br /> What more could you ask for ¯\_(ツ)_
<br />
<a href="https://svelteui.org/"><strong>Explore the docs »</strong></a>
<a href="https://svelteui.dev/"><strong>Explore the docs »</strong></a>
<br />
<a href="https://github.com/svelteuidev/svelteui/issues">Report Bug</a>
·
Expand All @@ -29,7 +29,7 @@

## **About The Project**

[Read the Changelog](https://svelteui.org/changelog/v0-6-0)
[Read the Changelog](https://svelteui.dev/changelog/v0-6-0)

### Features

Expand All @@ -44,17 +44,17 @@

## Packages

**[`@svelteui/core`](https://svelteui.org/core/button)** - core components library with 40+ components
**[`@svelteui/core`](https://svelteui.dev/core/button)** - core components library with 40+ components

**[`@svelteui/composables`](https://svelteui.org/composables/use-click-outside)** - collection of 20+ useful actions and utilities
**[`@svelteui/composables`](https://svelteui.dev/composables/use-click-outside)** - collection of 20+ useful actions and utilities

**[`@svelteui/dates`](https://svelteui.org/dates/getting-started)** - calendars, date and time pickers based on SvelteUI components
**[`@svelteui/dates`](https://svelteui.dev/dates/getting-started)** - calendars, date and time pickers based on SvelteUI components

**[`@svelteui/preprocessors`](https://svelteui.org/preprocessors/view-source)** - Svelte preprocessor library to assist in many areas of development
**[`@svelteui/preprocessors`](https://svelteui.dev/preprocessors/view-source)** - Svelte preprocessor library to assist in many areas of development

**[`@svelteui/motion`](https://svelteui.org/motion/typewriter)** - collection of transitions to utilize on dom elements
**[`@svelteui/motion`](https://svelteui.dev/motion/typewriter)** - collection of transitions to utilize on dom elements

**[`@svelteui/prism`](https://svelteui.org/others/prism)** - code highlight component built with prism action
**[`@svelteui/prism`](https://svelteui.dev/others/prism)** - code highlight component built with prism action

<br />

Expand All @@ -72,7 +72,7 @@ I want to build a friendly community that is happy to help those who need it. He
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

- If you have a suggestion that would make this project better, submit an issue
- If you would like to directly contribute, read the [contribution guide](https://svelteui.org/contributing) then submit a PR
- If you would like to directly contribute, read the [contribution guide](https://svelteui.dev/contributing) then submit a PR

<br />

Expand Down
2 changes: 1 addition & 1 deletion apps/docs/src/routes/core/menu/+page.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ By default,`Menu.Item` renders as buttons. To change that, set `root` prop on `M

```svelte
// Regular anchor as Menu.Item root element
<Menu.Item root="a" href="https://svelteui.org" target="_blank" />
<Menu.Item root="a" href="https://svelteui.dev" target="_blank" />
// Svelte component as Menu.Item root element
<Menu.Item root={CustomComponent} />
Expand Down
2 changes: 1 addition & 1 deletion packages/svelteui-composables/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"state",
"dom"
],
"homepage": "https://svelteui.org",
"homepage": "https://svelteui.dev",
"repository": {
"type": "git",
"url": "https://github.com/svelteuidev/svelteui",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ import type { Action } from '../../shared/actions/types';
* </div>
* ```
* @param params - Object that contains two properties {enabled: boolean, callback: (any) => unknown}
* @see https://svelteui.org/actions/use-click-outside
* @see https://svelteui.dev/actions/use-click-outside
*/
export function clickoutside(
node: HTMLElement,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import type { Action } from '../../shared/actions/types';
* ```
*
* @param text - The text that you want to be copied when the DOM element is clicked
* @see https://svelteui.org/actions/use-clipboard
* @see https://svelteui.dev/actions/use-clipboard
*/
export function clipboard(node: HTMLElement, text: string | (() => string)): ReturnType<Action> {
const click = async () => {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ import type { Action, UnknownKeyString } from '../../shared/actions/types';
* </style>
* ```
* @param props - A reactive object with properties that should be treated as css custom properties.
* @see https://svelteui.org/actions/use-css-variable
* @see https://svelteui.dev/actions/use-css-variable
*/
export function cssvariable(
node: HTMLElement,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import type { Action } from '../../shared/actions/types';
* <button use:download={{ blob: new Blob([]), filename: "text.txt" }} on:usedownload={() => { console.log('download');}}>Download</button>
* ```
* @param params - Object that contains two properties {blob: Blob, filename: string}
* @see https://svelteui.org/actions/use-download
* @see https://svelteui.dev/actions/use-download
*/
export function download(
node: HTMLElement,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import { createAriaHider } from './create-aria-hider';
* <input placeholder="Focused" />
* </div>
* ```
* @see https://svelteui.org/actions/use-focus-trap
* @see https://svelteui.dev/actions/use-focus-trap
*/
export function focustrap(node: HTMLElement, active = true): ReturnType<Action> | undefined {
let restoreAria: (() => void) | null = null;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import type { Action, FocusableElement } from '../../shared/actions/types';
* ```tsx
* <input use:focus placeholder="Focused"/>
* ```
* @see https://svelteui.org/actions/use-focus
* @see https://svelteui.dev/actions/use-focus
*/
export function focus(node: FocusableElement): ReturnType<Action> | undefined {
node.focus();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ function shouldFireEvent(event: KeyboardEvent) {
* </div>
* ```
* @param hotkeys - an array of HotKeyItem's which are arrays of key combinations and callback functions
* @see https://svelteui.org/actions/use-hotkey
* @see https://svelteui.dev/actions/use-hotkey
*/
export function hotkey(node: HTMLElement, hotkeys: HotkeyItem[]): ReturnType<Action> {
const keyDownListener = (event: KeyboardEvent) => {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ function observer() {
* <img use:lazy={{src:"/my-image"}} alt="My Image">
* ```
* @param attributes - an object whose properties are the attributes to be applied, and the values are the attr values
* @see https://svelteui.org/actions/use-lazy
* @see https://svelteui.dev/actions/use-lazy
*/
export function lazy(node: HTMLElement, attributes: Record<string, number | string>): ReturnType<Action> {
nodeAttributesMap.set(node, attributes);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ interface LockScrollOptions {
*
* @param lock - A boolean to specify whether or not to lock the screen
* @param options - An object to specify offset width
* @see https://svelteui.org/actions/use-lock-scroll
* @see https://svelteui.dev/actions/use-lock-scroll
*/
export function lockscroll(
node: HTMLElement,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import type { Action } from '../../shared/actions/types';
* </button>
* ```
* @param duration - The duration until the longpress event is dispatched
* @see https://svelteui.org/actions/use-longpress
* @see https://svelteui.dev/actions/use-longpress
*/
export function longpress(node: HTMLElement, duration: number): ReturnType<Action> {
let timer: number;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import type { Action } from '../../shared/actions/types';
* <div style="left: {position.x * 100}%; top: {position.y * 100}%;" />
* </div>
* ```
* @see https://svelteui.org/actions/use-move
* @see https://svelteui.dev/actions/use-move
*/
export function move(node: HTMLElement): ReturnType<Action> {
let moving: boolean = false;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import type { Action } from '../../shared/actions/types';
* <button use:persistenttab={true}>Keep tab open</button>
* ```
* @param enabled - Determines whether the action should execute or not.
* @see https://svelteui.org/actions/use-persistenttab
* @see https://svelteui.dev/actions/use-persistenttab
*/
export function persistenttab(node: HTMLElement, enabled: boolean): ReturnType<Action> {
function handler(e: BeforeUnloadEvent) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ type Target = HTMLElement | string;
* Usage: <div use:portal={'css selector'}> or <div use:portal={document.body}>
*
* @param target- DOM element or CSS selector to be appended to
* @see https://svelteui.org/actions/use-portal
* @see https://svelteui.dev/actions/use-portal
*/
export function portal(node: HTMLElement, target: Target = 'body'): ReturnType<Action> {
let targetNode;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import type { DebounceFilterOptions, FunctionArgs } from '../../shared/utils';
* @param opts options
*
* @return A new debounced function.
* @see https://svelteui.org/composables/use-debounce
* @see https://svelteui.dev/composables/use-debounce
*/
export function useDebounce<T extends FunctionArgs>(
fn: T,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import { browser } from '../../shared/utilities/utils/index.js';
*
* @param prefix prefix that is applied to the hash - defaults to `svelteui`
*
* @see https://svelteui.org/utilities/hash
* @see https://svelteui.dev/utilities/hash
*/
export function useHash(prefix: string = 'svelteui', persist: boolean = false): string {
if (persist && browser) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ function getOS() {
* }
* ```
*
* @see https://svelteui.org/utilities/os
* @see https://svelteui.dev/utilities/os
*/
export function useOs(): OS {
if (typeof window !== 'undefined') {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ const browser = isBrowser();
*
* @param fn callback function
* @param options controls whether the callback is triggered immediately
* @see https://svelteui.org/utilities/raf-fn
* @see https://svelteui.dev/utilities/raf-fn
*/
export function useRafFn(fn: () => void, options: RafFnOptions = {}): Pauseable {
const { immediate = true } = options;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import type { FunctionArgs } from '../../shared/utils';
* @param leading if true, call fn on the leading edge of the ms timeout
*
* @return A new throttled function.
* @see https://svelteui.org/composables/use-throttle
* @see https://svelteui.dev/composables/use-throttle
*/
export function useThrottle<T extends FunctionArgs>(
fn: T,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ export interface UseWebWorkerReturn {
/**
* Run expensive function without blocking the UI, using a simple syntax that makes use of Promise.
*
* @see https://svelteui.org/composables/use-web-worker
* @see https://svelteui.dev/composables/use-web-worker
* @param fn
* @param options
*/
Expand Down
2 changes: 1 addition & 1 deletion packages/svelteui-core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Instead of remaking the same components, recreating custom actions, transitions,

# Installation

See https://www.svelteui.org/installation for complete guide.
See https://www.svelteui.dev/installation for complete guide.

```
npm i @svelteuidev/core @svelteuidev/composables
Expand Down
2 changes: 1 addition & 1 deletion packages/svelteui-core/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"design",
"stitches"
],
"homepage": "https://svelteui.org",
"homepage": "https://svelteui.dev",
"repository": {
"type": "git",
"url": "https://github.com/svelteuidev/svelteui",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@
Accordion component that allows the collapsing of each item.
@see https://svelteui.org/core/accordion
@see https://svelteui.dev/core/accordion
@example
```svelte
<Accordion defaultValue="typescript">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
Item of an accordion.
@see https://svelteui.org/core/accordion
@see https://svelteui.dev/core/accordion
@example
```svelte
<Accordion.Item value="typescript">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@
Icon button to indicate secondary action.
@see https://svelteui.org/core/action-icon
@see https://svelteui.dev/core/action-icon
@example
```tsx
<ActionIcon>Click</ActionIcon> // standard ActionIcon
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
CloseButton is a premade ActionIcon with close icon
@see https://svelteui.org/core/action-icon
@see https://svelteui.dev/core/action-icon
@example
```tsx
<CloseButton /> // standard CloseButton
Expand Down
6 changes: 3 additions & 3 deletions packages/svelteui-core/src/components/Anchor/Anchor.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,11 @@
Display an anchor text that is a wrapper around `Text` component using an `a` as the default
root.
@see https://svelteui.org/core/anchor
@see https://svelteui.dev/core/anchor
@example
```svelte
<Anchor href="https://svelteui.org/">Main Page</Anchor>
<Anchor root={ Button } href="https://svelteui.org/" target="_blank">Documentation</Anchor>
<Anchor href="https://svelteui.dev/">Main Page</Anchor>
<Anchor root={ Button } href="https://svelteui.dev/" target="_blank">Documentation</Anchor>
<Anchor root={ Link } to="/home" color='violet' size='lg'>Click here</Anchor>
```
-->
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
Enforce desired width/height ratio.
@see https://svelteui.org/core/aspect-ratio
@see https://svelteui.dev/core/aspect-ratio
@example
```svelte
<AspectRatio ratio={16 / 9}>
Expand Down
2 changes: 1 addition & 1 deletion packages/svelteui-core/src/components/Badge/Badge.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
Display badge, pill or tag
@see https://svelteui.org/core/badge
@see https://svelteui.dev/core/badge
@example
```svelte
<Badge>Badge</Badge>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
Blockquote with icon and citation
@see https://svelteui.org/core/blockquote
@see https://svelteui.dev/core/blockquote
@example
```tsx
<Blockquote>
Expand Down
2 changes: 1 addition & 1 deletion packages/svelteui-core/src/components/Box/Box.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@
Add inline styles to any element or component with sx.
@see https://svelteui.org/core/box
@see https://svelteui.dev/core/box
@example
```svelte
<Box css={{backgroundColor: '$blue600'}}>example</Box>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

<Template let:args>
<Breadcrumbs {...args} size="md">
<Breadcrumbs.Item href="https://svelteui.org">Home</Breadcrumbs.Item>
<Breadcrumbs.Item href="https://svelteui.dev">Home</Breadcrumbs.Item>
<Breadcrumbs.Item active={true}>Application List</Breadcrumbs.Item>
</Breadcrumbs>
</Template>
Expand All @@ -18,7 +18,7 @@

<Story name="Icon" id="breadcrumbsIconStory">
<Breadcrumbs size="md">
<Breadcrumbs.Item href="https://svelteui.org">
<Breadcrumbs.Item href="https://svelteui.dev">
<IconRenderer slot="icon" icon={Home} />
</Breadcrumbs.Item>
<Breadcrumbs.Item>
Expand All @@ -31,7 +31,7 @@

<Story name="Separator" id="breadcrumbsSeparatorStory">
<Breadcrumbs size="md" separator="">
<Breadcrumbs.Item href="https://svelteui.org">
<Breadcrumbs.Item href="https://svelteui.dev">
<IconRenderer slot="icon" icon={Home} />
</Breadcrumbs.Item>
<Breadcrumbs.Item>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,5 +57,5 @@
name="With href"
id="buttonHrefStory"
template="variants"
args={{ href: 'https://www.svelteui.org', external: true, disabled: false, loading: false }}
args={{ href: 'https://www.svelteui.dev', external: true, disabled: false, loading: false }}
/>
Loading

0 comments on commit a854d0c

Please sign in to comment.