Skip to content

Commit

Permalink
[core]: updated urls
Browse files Browse the repository at this point in the history
  • Loading branch information
Kamell Perry committed May 13, 2022
1 parent ae22f50 commit d98b0c8
Show file tree
Hide file tree
Showing 47 changed files with 61 additions and 61 deletions.
16 changes: 8 additions & 8 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-docs.vercel.app/"><strong>Explore the docs »</strong></a>
<a href="https://svelteuidev.github.io/svelteui/"><strong>Explore the docs »</strong></a>
<br />
<a href="https://github.com/svelteuidev/svelteui/issues">Report Bug</a>
·
Expand All @@ -31,7 +31,7 @@

## **About The Project**

[Read the Changelog](https://svelteui-docs.vercel.app/docs/changelog)
[Read the Changelog](https://svelteuidev.github.io/svelteui/docs/changelog)

### Features

Expand All @@ -44,18 +44,18 @@

### Undocumented Components & Functions

The [docs](https://svelteui-docs.vercel.app/) are still under construction. Some of the library's exported components & functions are still undocumented. [Here](https://github.com/svelteuidev/svelteui/issues/15) is where you can keep track of the progress.
The [docs](https://svelteuidev.github.io/svelteui/) are still under construction. Some of the library's exported components & functions are still undocumented. [Here](https://github.com/svelteuidev/svelteui/issues/15) is where you can keep track of the progress.

> Please keep in mind that any undocumented component could potentially receive breaking API changes or be heavily updated before being finalized.
<br />

## Packages

- [`@svelteui/core`](https://svelteui-docs.vercel.app/docs/core/button) – core components library with 8+ components
- [`@svelteui/actions`](https://svelteui-docs.vercel.app/docs/actions/use-click-outside) – library of useful actions
- [`@svelteui/motion`](https://svelteui-docs.vercel.app/docs/motion/typewriter) – library of transitions to utilize on dom elements
- [`@svelteui/utilities`](https://svelteui-docs.vercel.app/docs/utilities/os) – library of helpful utility functions
- [`@svelteui/core`](https://svelteuidev.github.io/svelteui/docs/core/button) – core components library with 8+ components
- [`@svelteui/actions`](https://svelteuidev.github.io/svelteui/docs/actions/use-click-outside) – library of useful actions
- [`@svelteui/motion`](https://svelteuidev.github.io/svelteui/docs/motion/typewriter) – library of transitions to utilize on dom elements
- [`@svelteui/utilities`](https://svelteuidev.github.io/svelteui/docs/utilities/os) – library of helpful utility functions
- `@svelteui/prism` – code highlight component built with prism (coming in 0.6.0 release)

<br />
Expand All @@ -74,7 +74,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-docs.vercel.app/docs/contribute) then submit a PR
- If you would like to directly contribute, read the [contribution guide](https://svelteuidev.github.io/svelteui/docs/contribute) then submit a PR

<br />

Expand Down
10 changes: 5 additions & 5 deletions packages/svelteui-actions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

## Documentation

[See full documentation on svelteui website](https://svelteui-docs.vercel.app/)
[See full documentation on svelteui website](https://svelteuidev.github.io/svelteui/)

## Installation

Expand All @@ -21,10 +21,10 @@ npm i @svelteuidev/actions

## Included Actions

- [use-click-outside](https://svelteui-docs.vercel.app/docs/actions/use-click-outside) – Triggers a callback when a user clicks outside of a given element.
- [use-clipboard](https://svelteui-docs.vercel.app/docs/actions/use-clipboard) - Copies text to the clipboard when dom element is clicked
- [use-css-variable](https://svelteui-docs.vercel.app/docs/actions/use-css-variable) - Update css properties on the fly whenever some of their values change.
- [use-focus](https://svelteui-docs.vercel.app/docs/actions/use-focus) - Calls focus on a node once mounted into the dom
- [use-click-outside](https://svelteuidev.github.io/svelteui/docs/actions/use-click-outside) – Triggers a callback when a user clicks outside of a given element.
- [use-clipboard](https://svelteuidev.github.io/svelteui/docs/actions/use-clipboard) - Copies text to the clipboard when dom element is clicked
- [use-css-variable](https://svelteuidev.github.io/svelteui/docs/actions/use-css-variable) - Update css properties on the fly whenever some of their values change.
- [use-focus](https://svelteuidev.github.io/svelteui/docs/actions/use-focus) - Calls focus on a node once mounted into the dom

## License

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ import type { Action } from '../types/ActionTypes';
* </div>
* ```
* @param params - Object that contains two properties {enabled: boolean, callback: (any) => unknown}
* @see https://svelteui-docs.vercel.app/docs/actions/use-click-outside
* @see https://svelteuidev.github.io/svelteui/docs/actions/use-click-outside
*/
export function clickoutside(
node: HTMLElement,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import type { Action } from '../types/ActionTypes';
* <button use:clipboard={'This text will be copied'}>Copy Me</button>
* ```
* @param text - The text that you want to be copied when the DOM element is clicked
* @see https://svelteui-docs.vercel.app/docs/actions/use-clipboard
* @see https://svelteuidev.github.io/svelteui/docs/actions/use-clipboard
*/
export function clipboard(node: HTMLElement, text: 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 '../types/ActionTypes';
* </style>
* ```
* @param props - A reactive object with properties that should be treated as css custom properties.
* @see https://svelteui-docs.vercel.app/docs/actions/use-css-variable
* @see https://svelteuidev.github.io/svelteui/docs/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 '../types/ActionTypes';
* <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-docs.vercel.app/docs/actions/use-download
* @see https://svelteuidev.github.io/svelteui/docs/actions/use-download
*/
export function download(
node: HTMLElement,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import type { Action, FocusableElement } from '../types/ActionTypes';
* ```tsx
* <button use:clipboard={'This text will be copied'}>Copy Me</button>
* ```
* @see https://svelteui-docs.vercel.app/docs/actions/use-focus
* @see https://svelteuidev.github.io/svelteui/docs/actions/use-focus
*/
export function focus(node: FocusableElement): ReturnType<Action> {
node.focus();
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-docs.vercel.app/docs/actions/use-lazy
* @see https://svelteuidev.github.io/svelteui/docs/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 @@ -9,7 +9,7 @@ import type { Action } from '../types';
* </button>
* ```
* @param duration - The duration until the longpress event is dispatched
* @see https://svelteui-docs.vercel.app/docs/actions/use-longpress
* @see https://svelteuidev.github.io/svelteui/docs/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 @@ -7,7 +7,7 @@ import type { Action } from '../types';
* <button use:persistenttab={true}>Keep tab open</button>
* ```
* @param enabled - Determines whether the action should execute or not.
* @see https://svelteui-docs.vercel.app/docs/actions/use-persistenttab
* @see https://svelteuidev.github.io/svelteui/docs/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-docs.vercel.app/docs/actions/use-portal
* @see https://svelteuidev.github.io/svelteui/docs/actions/use-portal
*/
export function portal(node: HTMLElement, target: Target = 'body'): ReturnType<Action> {
let targetNode;
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 @@ -8,7 +8,7 @@

## Documentation

[See full documentation on svelteui website](https://svelteui-docs.vercel.app/)
[See full documentation on svelteui website](https://svelteuidev.github.io/svelteui/)

## Installation

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@
Icon button to indicate secondary action.
@see https://svelteui-docs.vercel.app/docs/core/action-icon
@see https://svelteuidev.github.io/svelteui/docs/core/action-icon
@example
```tsx
<ActionIcon>Click</ActionIcon> // standard ActionIcon
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
CloseButton is a premade ActionIcon with close icon
@see https://svelteui-docs.vercel.app/docs/core/action-icon
@see https://svelteuidev.github.io/svelteui/docs/core/action-icon
@example
```tsx
<CloseButton /> // standard CloseButton
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@
Display badge, pill or tag
@see https://svelteui-docs.vercel.app/docs/core/badge
@see https://svelteuidev.github.io/svelteui/docs/core/badge
@example
```svelte
<Badge>Badge</Badge>
Expand Down
2 changes: 1 addition & 1 deletion packages/svelteui-core/src/lib/components/Box/Box.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
Add inline styles to any element or component with sx.
@see https://svelteui-docs.vercel.app/docs/core/box
@see https://svelteuidev.github.io/svelteui/docs/core/box
@example
```svelte
<Box css={{backgroundColor: '$blue600'}}>example</Box>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@
@component
A user can perform an immediate action by pressing a button. It's frequently used to start an action, but it can also be used to link to other pages.
@see https://svelteui-docs.vercel.app/docs/core/button
@see https://svelteuidev.github.io/svelteui/docs/core/button
@example
```tsx
<Button>Click</Button> // standard button
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
Centers content vertically and horizontally.
@see https://svelteui-docs.vercel.app/docs/core/center
@see https://svelteuidev.github.io/svelteui/docs/core/center
@example
```svelte
<Center override={{ width: 400, height: 200, bg: '$blue100' }}>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@
A checkbox input component using the theme styles with support for a label and indeterminate state.
@see https://svelteui-docs.vercel.app/docs/core/checkbox
@see https://svelteuidev.github.io/svelteui/docs/core/checkbox
@example
```svelte
<Checkbox />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
A checkbox group component using the theme styles and builds a set of checkboxes according to
the items passed.
@see https://svelteui-docs.vercel.app/docs/core/checkbox
@see https://svelteuidev.github.io/svelteui/docs/core/checkbox
@example
```svelte
<CheckboxGroup bind:value items={items} />
Expand Down
2 changes: 1 addition & 1 deletion packages/svelteui-core/src/lib/components/Code/Code.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@
@component
Inline or block code without syntax highlighting
@see https://svelteui-docs.vercel.app/docs/core/code
@see https://svelteuidev.github.io/svelteui/docs/core/code
@example
```tsx
<Code color='green' size='lg' variant='bars' /> // standard code component
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
Center content horizontally with predefined max-width
@see https://svelteui-docs.vercel.app/docs/core/container
@see https://svelteuidev.github.io/svelteui/docs/core/container
@example
```svelte
<Container>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
@component
Fragments let you group a list of children without adding extra nodes to the DOM.
@see https://svelteui-docs.vercel.app/docs/core/fragment
@see https://svelteuidev.github.io/svelteui/docs/core/fragment
@example
```svelte
<Fragment>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@
Compose elements and components in a vertical flex container.
@see https://svelteui-docs.vercel.app/docs/core/group
@see https://svelteuidev.github.io/svelteui/docs/core/group
@example
```svelte
<Group children={3} grow>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
BackgroundImage component can be used to add any content on image. It is useful for hero headers and other similar sections
@see https://svelteui-docs.vercel.app/docs/core/image
@see https://svelteuidev.github.io/svelteui/docs/core/image
@example
```svelte
<script>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@
Dynamic Image component with optional placeholder for loading and error state
@see https://svelteui-docs.vercel.app/docs/core/image
@see https://svelteuidev.github.io/svelteui/docs/core/image
@example
```tsx
<Image src="https://images.unsplash.com/photo-1561046259-7d5b6e929ba0"/> // standard image
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -279,7 +279,7 @@
Base component to create custom inputs
@see https://svelteui-docs.vercel.app/docs/core/input
@see https://svelteuidev.github.io/svelteui/docs/core/input
@example
```svelte
<Input
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
@component
The Loader component creates a loading icon. There are three different Loaders with the circle as the default.
@see https://svelteui-docs.vercel.app/docs/core/loader
@see https://svelteuidev.github.io/svelteui/docs/core/loader
@example
```tsx
<Loader color='green' size='lg' variant='bars' />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@
Capture user feedback limited to large set of options
@see https://svelteui-docs.vercel.app/docs/core/native-select
@see https://svelteuidev.github.io/svelteui/docs/core/native-select
@example
```svelte
<NativeSelect
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
Overlays given element with div element with any color and opacity
@see https://svelteui-docs.vercel.app/docs/core/overlay
@see https://svelteuidev.github.io/svelteui/docs/core/overlay
@example
```svelte
<Box sx={{ height: 100, position: 'relative' }}>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
Responsive grid where each item takes equal amount of space
@see https://svelteui-docs.vercel.app/docs/core/input
@see https://svelteuidev.github.io/svelteui/docs/core/input
@example
```svelte
<SimpleGrid cols={3}>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
Add horizontal or vertical spacing from theme.
@see https://svelteui-docs.vercel.app/docs/core/space
@see https://svelteuidev.github.io/svelteui/docs/core/space
@example
```svelte
<Group children={3} grow>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
Compose elements and components in a vertical flex container.
@see https://svelteui-docs.vercel.app/docs/core/stack
@see https://svelteuidev.github.io/svelteui/docs/core/stack
@example
```svelte
<Stack align="flex-end" justify="space-between" override={{ height: 300 }}>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@
A user can use this component to enable/disable something, normally used for boolean values or for binary actions.
@see https://svelteui-docs.vercel.app/docs/core/switch
@see https://svelteuidev.github.io/svelteui/docs/core/switch
@example
```tsx
<Switch/> // standard switch
Expand Down
2 changes: 1 addition & 1 deletion packages/svelteui-core/src/lib/components/Text/Text.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@
Display text and links with theme styles.
@see https://svelteui-docs.vercel.app/docs/core/text
@see https://svelteuidev.github.io/svelteui/docs/core/text
@example
```tsx
<Text size='lg'>This is a text</Text> // standard text component
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
Render icon inside element with theme colors
@see https://svelteui-docs.vercel.app/docs/core/theme-icon
@see https://svelteuidev.github.io/svelteui/docs/core/theme-icon
@example
```svelte
<ThemeIcon>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
Display text that uses title styling and title HTML tags.
@see https://svelteui-docs.vercel.app/docs/core/title
@see https://svelteuidev.github.io/svelteui/docs/core/title
@example
```tsx
<Title>This is a title</Title> // standard title component
Expand Down
2 changes: 1 addition & 1 deletion packages/svelteui-dates/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

## Documentation

[See full documentation on svelteui website](https://svelteui-docs.vercel.app/)
[See full documentation on svelteui website](https://svelteuidev.github.io/svelteui/)

## Installation

Expand Down
Loading

0 comments on commit d98b0c8

Please sign in to comment.