Skip to content

Commit

Permalink
Replace all docs PNG image with WebP (#13545)
Browse files Browse the repository at this point in the history
  • Loading branch information
LitoMore authored Jul 24, 2024
1 parent bf351c1 commit d2fb56c
Show file tree
Hide file tree
Showing 240 changed files with 125 additions and 118 deletions.
Binary file removed docs/.gitbook/assets/action-panel.png
Binary file not shown.
Binary file added docs/.gitbook/assets/action-panel.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/alert-action-cancel.png
Binary file not shown.
Binary file added docs/.gitbook/assets/alert-action-cancel.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/alert-action-default.png
Binary file not shown.
Binary file added docs/.gitbook/assets/alert-action-default.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/alert-action-destructive.png
Binary file not shown.
Binary file not shown.
Binary file removed docs/.gitbook/assets/alert.png
Binary file not shown.
Binary file added docs/.gitbook/assets/alert.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/arguments.png
Binary file not shown.
Binary file added docs/.gitbook/assets/arguments.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/background-refresh-error.png
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file removed docs/.gitbook/assets/basics-icon-list.png
Binary file not shown.
Binary file added docs/.gitbook/assets/basics-icon-list.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/basics-inapp-store.png
Binary file not shown.
Binary file added docs/.gitbook/assets/basics-inapp-store.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/basics-install-extension.png
Binary file not shown.
Binary file not shown.
Binary file removed docs/.gitbook/assets/basics-manage-extensions.png
Binary file not shown.
Binary file not shown.
Binary file removed docs/.gitbook/assets/basics-open-command.png
Binary file not shown.
Binary file added docs/.gitbook/assets/basics-open-command.webp
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file removed docs/.gitbook/assets/basics-unhandled-exception.png
Binary file not shown.
Binary file not shown.
Binary file removed docs/.gitbook/assets/basics-web-store.png
Binary file not shown.
Binary file added docs/.gitbook/assets/basics-web-store.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/categories-focus.png
Binary file not shown.
Binary file added docs/.gitbook/assets/categories-focus.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/changelog-hello-world.png
Binary file not shown.
Binary file added docs/.gitbook/assets/changelog-hello-world.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/color-blue.png
Binary file not shown.
Binary file added docs/.gitbook/assets/color-blue.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/color-dark-blue.png
Binary file not shown.
Binary file added docs/.gitbook/assets/color-dark-blue.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/color-dark-green.png
Binary file not shown.
Binary file added docs/.gitbook/assets/color-dark-green.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/color-dark-magenta.png
Binary file not shown.
Binary file added docs/.gitbook/assets/color-dark-magenta.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/color-dark-orange.png
Binary file not shown.
Binary file added docs/.gitbook/assets/color-dark-orange.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/color-dark-primary-text.png
Binary file not shown.
Binary file added docs/.gitbook/assets/color-dark-primary-text.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/color-dark-purple.png
Binary file not shown.
Binary file added docs/.gitbook/assets/color-dark-purple.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/color-dark-red.png
Diff not rendered.
Binary file added docs/.gitbook/assets/color-dark-red.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/color-dark-secondary-text.png
Diff not rendered.
Binary file added docs/.gitbook/assets/color-dark-secondary-text.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/color-dark-yellow.png
Diff not rendered.
Binary file added docs/.gitbook/assets/color-dark-yellow.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/color-green.png
Diff not rendered.
Binary file added docs/.gitbook/assets/color-green.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/color-magenta.png
Diff not rendered.
Binary file added docs/.gitbook/assets/color-magenta.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/color-orange.png
Diff not rendered.
Binary file added docs/.gitbook/assets/color-orange.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/color-primary-text.png
Diff not rendered.
Binary file added docs/.gitbook/assets/color-primary-text.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/color-purple.png
Diff not rendered.
Binary file added docs/.gitbook/assets/color-purple.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/color-red.png
Diff not rendered.
Binary file added docs/.gitbook/assets/color-red.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/color-secondary-text.png
Diff not rendered.
Binary file added docs/.gitbook/assets/color-secondary-text.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/color-yellow.png
Diff not rendered.
Binary file added docs/.gitbook/assets/color-yellow.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/deeplink-confirmation.png
Diff not rendered.
Binary file added docs/.gitbook/assets/deeplink-confirmation.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/detail-metadata-label.png
Diff not rendered.
Binary file added docs/.gitbook/assets/detail-metadata-label.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/detail-metadata-link.png
Diff not rendered.
Binary file added docs/.gitbook/assets/detail-metadata-link.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/detail-metadata-separator.png
Diff not rendered.
Binary file not shown.
Binary file removed docs/.gitbook/assets/detail-metadata-taglist.png
Diff not rendered.
Binary file added docs/.gitbook/assets/detail-metadata-taglist.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/detail-metadata.png
Diff not rendered.
Binary file added docs/.gitbook/assets/detail-metadata.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/detail.png
Diff not rendered.
Binary file added docs/.gitbook/assets/detail.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/example-create-todo.png
Diff not rendered.
Binary file added docs/.gitbook/assets/example-create-todo.webp
Binary file not shown.
Diff not rendered.
Binary file not shown.
Binary file removed docs/.gitbook/assets/example-hacker-news.png
Diff not rendered.
Binary file added docs/.gitbook/assets/example-hacker-news.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/example-spotify-controls.png
Diff not rendered.
Binary file not shown.
Binary file removed docs/.gitbook/assets/example-todo-list.png
Diff not rendered.
Binary file added docs/.gitbook/assets/example-todo-list.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/extension-issues.png
Diff not rendered.
Binary file added docs/.gitbook/assets/extension-issues.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/fork-extension.png
Diff not rendered.
Binary file added docs/.gitbook/assets/fork-extension.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/form-checkbox.png
Diff not rendered.
Binary file added docs/.gitbook/assets/form-checkbox.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/form-datepicker.png
Diff not rendered.
Binary file added docs/.gitbook/assets/form-datepicker.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/form-description.png
Diff not rendered.
Binary file added docs/.gitbook/assets/form-description.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/form-drafts.png
Diff not rendered.
Binary file added docs/.gitbook/assets/form-drafts.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/form-dropdown.png
Diff not rendered.
Binary file added docs/.gitbook/assets/form-dropdown.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/form-filepicker-multiple.png
Diff not rendered.
Binary file not shown.
Binary file removed docs/.gitbook/assets/form-filepicker-single.png
Diff not rendered.
Binary file added docs/.gitbook/assets/form-filepicker-single.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/form-password.png
Diff not rendered.
Binary file added docs/.gitbook/assets/form-password.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/form-separator.png
Diff not rendered.
Binary file added docs/.gitbook/assets/form-separator.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/form-tagpicker.png
Diff not rendered.
Binary file added docs/.gitbook/assets/form-tagpicker.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/form-textarea.png
Diff not rendered.
Binary file added docs/.gitbook/assets/form-textarea.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/form-textfield.png
Diff not rendered.
Binary file added docs/.gitbook/assets/form-textfield.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/form-validation.png
Diff not rendered.
Binary file added docs/.gitbook/assets/form-validation.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/go-to-ref.png
Diff not rendered.
Binary file added docs/.gitbook/assets/go-to-ref.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/good-subtitle.png
Diff not rendered.
Binary file added docs/.gitbook/assets/good-subtitle.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/grid-empty-view.png
Diff not rendered.
Binary file added docs/.gitbook/assets/grid-empty-view.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/grid-item-accessories.png
Diff not rendered.
Binary file added docs/.gitbook/assets/grid-item-accessories.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/grid-styled-sections.png
Diff not rendered.
Binary file added docs/.gitbook/assets/grid-styled-sections.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/grid.png
Diff not rendered.
Binary file added docs/.gitbook/assets/grid.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/hello-world-2.png
Diff not rendered.
Binary file added docs/.gitbook/assets/hello-world-2.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/hello-world.png
Diff not rendered.
Binary file added docs/.gitbook/assets/hello-world.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/hn-store.png
Diff not rendered.
Binary file added docs/.gitbook/assets/hn-store.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/hud.png
Diff not rendered.
Binary file added docs/.gitbook/assets/hud.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/introduction-hello-world.png
Diff not rendered.
Binary file not shown.
Binary file removed docs/.gitbook/assets/list-detail-metadata-label.png
Diff not rendered.
Binary file not shown.
Binary file removed docs/.gitbook/assets/list-detail-metadata-link.png
Diff not rendered.
Binary file not shown.
Diff not rendered.
Binary file not shown.
Binary file removed docs/.gitbook/assets/list-detail-metadata-split.png
Diff not rendered.
Binary file not shown.
Diff not rendered.
Binary file not shown.
Diff not rendered.
Binary file not shown.
Binary file removed docs/.gitbook/assets/list-detail.png
Diff not rendered.
Binary file added docs/.gitbook/assets/list-detail.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/list-empty-view.png
Diff not rendered.
Binary file added docs/.gitbook/assets/list-empty-view.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/list-item-accessories.png
Diff not rendered.
Binary file added docs/.gitbook/assets/list-item-accessories.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/list.png
Diff not rendered.
Binary file added docs/.gitbook/assets/list.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/menu-bar-activate-command.png
Diff not rendered.
Binary file not shown.
Binary file removed docs/.gitbook/assets/menu-bar-command.gif
Diff not rendered.
Binary file removed docs/.gitbook/assets/menu-bar-refresh.png
Diff not rendered.
Binary file added docs/.gitbook/assets/menu-bar-refresh.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/menu-bar-run-in-background.png
Diff not rendered.
Binary file not shown.
Diff not rendered.
Binary file not shown.
Binary file removed docs/.gitbook/assets/oauth-overlay-twitter.png
Diff not rendered.
Binary file added docs/.gitbook/assets/oauth-overlay-twitter.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/required-preference.png
Diff not rendered.
Binary file added docs/.gitbook/assets/required-preference.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/required-preferences-2.png
Diff not rendered.
Binary file added docs/.gitbook/assets/required-preferences-2.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/teams-create-organization.png
Diff not rendered.
Binary file not shown.
Binary file removed docs/.gitbook/assets/teams-create-repository.png
Diff not rendered.
Binary file not shown.
Binary file removed docs/.gitbook/assets/teams-develop-extension.png
Diff not rendered.
Binary file not shown.
Binary file removed docs/.gitbook/assets/teams-publish-extension.png
Diff not rendered.
Binary file added docs/.gitbook/assets/teams-publish-extension.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/toast-animated.png
Diff not rendered.
Binary file added docs/.gitbook/assets/toast-animated.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/toast-failure.png
Diff not rendered.
Binary file added docs/.gitbook/assets/toast-failure.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/toast-success.png
Diff not rendered.
Binary file added docs/.gitbook/assets/toast-success.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/toast.png
Diff not rendered.
Binary file added docs/.gitbook/assets/toast.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/version-history.png
Diff not rendered.
Binary file added docs/.gitbook/assets/version-history.webp
Binary file not shown.
Binary file removed docs/.gitbook/assets/welcome.png
Diff not rendered.
Binary file added docs/.gitbook/assets/welcome.webp
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: Start building your perfect tools with the Raycast API.

Welcome, developers! Our docs cover guides, examples, references, and more to help you build extensions and share them with [our community](https://raycast.com/community) and [your team](teams/getting-started.md).

![](.gitbook/assets/introduction-hello-world.png)
![](.gitbook/assets/introduction-hello-world.webp)

The Raycast Platform consists of two parts:

Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/feedback/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ Raycast has several ways to provide feedback to the user:
- [HUD](./hud.md) _- to confirm an action worked after closing Raycast_
- [Alert](./alert.md) _- to ask for confirmation before taking an action_

![](../../.gitbook/assets/toast.png)
![](../../.gitbook/assets/toast.webp)
12 changes: 6 additions & 6 deletions docs/api-reference/feedback/alert.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

When the user takes an important action (for example when irreversibly deleting something), you can ask for confirmation by using `confirmAlert`.

![](../../.gitbook/assets/alert.png)
![](../../.gitbook/assets/alert.webp)

## API Reference

Expand Down Expand Up @@ -89,8 +89,8 @@ Use [Alert.ActionStyle.Destructive](#alert.actionstyle) for confirmations of a d

#### Enumeration members

| Name | Value |
| :---------- | :------------------------------------------------------ |
| Default | ![](../../.gitbook/assets/alert-action-default.png) |
| Destructive | ![](../../.gitbook/assets/alert-action-destructive.png) |
| Cancel | ![](../../.gitbook/assets/alert-action-cancel.png) |
| Name | Value |
| :---------- | :------------------------------------------------------- |
| Default | ![](../../.gitbook/assets/alert-action-default.webp) |
| Destructive | ![](../../.gitbook/assets/alert-action-destructive.webp) |
| Cancel | ![](../../.gitbook/assets/alert-action-cancel.webp) |
7 changes: 5 additions & 2 deletions docs/api-reference/feedback/hud.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

When the user takes an action that has the side effect of closing Raycast (for example when copying something in the [Clipboard](../clipboard.md)), you can use a HUD to confirm that the action worked properly.

![](../../.gitbook/assets/hud.png)
![](../../.gitbook/assets/hud.webp)

## API Reference

Expand All @@ -13,7 +13,10 @@ A HUD will automatically hide the main window and show a compact message at the
#### Signature

```typescript
async function showHUD(title: string, options?: { clearRootSearch?: boolean; popToRootType?: PopToRootType }): Promise<void>;
async function showHUD(
title: string,
options?: { clearRootSearch?: boolean; popToRootType?: PopToRootType }
): Promise<void>;
```

#### Example
Expand Down
12 changes: 6 additions & 6 deletions docs/api-reference/feedback/toast.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ When an asynchronous operation is happening or when an error is thrown, it's usu

Additionally, Toasts can have some actions associated to the action they are about. For example, you could provide a way to cancel an asynchronous operation, undo an action, or copy the stack trace of an error.

![](../../.gitbook/assets/toast.png)
![](../../.gitbook/assets/toast.webp)

## API Reference

Expand Down Expand Up @@ -133,11 +133,11 @@ You can hide it later by using [Toast.hide](#toast) or update the properties of

#### Enumeration members

| Name | Value |
| :------- | :-------------------------------------------- |
| Animated | ![](../../.gitbook/assets/toast-animated.png) |
| Success | ![](../../.gitbook/assets/toast-success.png) |
| Failure | ![](../../.gitbook/assets/toast-failure.png) |
| Name | Value |
| :------- | :--------------------------------------------- |
| Animated | ![](../../.gitbook/assets/toast-animated.webp) |
| Success | ![](../../.gitbook/assets/toast-success.webp) |
| Failure | ![](../../.gitbook/assets/toast-failure.webp) |

### Toast.ActionOptions

Expand Down
6 changes: 3 additions & 3 deletions docs/api-reference/menu-bar-commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,11 +71,11 @@ Of course, our pull request command wouldn't be of that much use if we had to te

Your root search should look similar to:

![Menu Bar Command - Activate Background Refresh](../.gitbook/assets/menu-bar-activate-command.png)
![Menu Bar Command - Activate Background Refresh](../.gitbook/assets/menu-bar-activate-command.webp)

Running it once should activate it to:

![Menu Bar Command - Refresh](../.gitbook/assets/menu-bar-refresh.png)
![Menu Bar Command - Refresh](../.gitbook/assets/menu-bar-refresh.webp)

## Lifecycle

Expand All @@ -96,7 +96,7 @@ If your `menu-bar` command also makes use of [background refresh](../information

{% hint style="info" %}
To ease testing, commands configured to run in the background have an extra action in development mode:
![Menu Bar Command - Run in Background](../.gitbook/assets/menu-bar-run-in-background.png)
![Menu Bar Command - Run in Background](../.gitbook/assets/menu-bar-run-in-background.webp)
{% endhint %}

### When the user clicks the command's icon / title in the menu bar
Expand Down
4 changes: 2 additions & 2 deletions docs/api-reference/oauth.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Before considering OAuth, first check if your provider supports PKCE. You can us

## OAuth Flow

![](../.gitbook/assets/oauth-overlay-twitter.png)
![](../.gitbook/assets/oauth-overlay-twitter.webp)

The OAuth flow from an extension looks like this:

Expand All @@ -21,7 +21,7 @@ The OAuth flow from an extension looks like this:
When the flow is complete, the extension has received an access token from the provider and can perform API calls.
The API provides functions for securely storing and retrieving token sets, so that an extension can check whether the user is already logged in and whether an expired access token needs to be refreshed. Raycast also automatically shows a logout preference.

![](../.gitbook/assets/oauth-overlay-twitter-success.png)
![](../.gitbook/assets/oauth-overlay-twitter-success.webp)

## OAuth App

Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/user-interface/action-panel.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Action Panel

![](../../.gitbook/assets/action-panel.png)
![](../../.gitbook/assets/action-panel.webp)

## API Reference

Expand Down
22 changes: 11 additions & 11 deletions docs/api-reference/user-interface/colors.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,17 +38,17 @@ export default function Command() {

#### Enumeration members

| Name | Dark Theme | Light Theme |
| :------------ | :------------------------------------------------------- | :-------------------------------------------------- |
| Blue | ![](../../.gitbook/assets/color-dark-blue.png) | ![](../../.gitbook/assets/color-blue.png) |
| Green | ![](../../.gitbook/assets/color-dark-green.png) | ![](../../.gitbook/assets/color-green.png) |
| Magenta | ![](../../.gitbook/assets/color-dark-magenta.png) | ![](../../.gitbook/assets/color-magenta.png) |
| Orange | ![](../../.gitbook/assets/color-dark-orange.png) | ![](../../.gitbook/assets/color-orange.png) |
| Purple | ![](../../.gitbook/assets/color-dark-purple.png) | ![](../../.gitbook/assets/color-purple.png) |
| Red | ![](../../.gitbook/assets/color-dark-red.png) | ![](../../.gitbook/assets/color-red.png) |
| Yellow | ![](../../.gitbook/assets/color-dark-yellow.png) | ![](../../.gitbook/assets/color-yellow.png) |
| PrimaryText | ![](../../.gitbook/assets/color-dark-primary-text.png) | ![](../../.gitbook/assets/color-primary-text.png) |
| SecondaryText | ![](../../.gitbook/assets/color-dark-secondary-text.png) | ![](../../.gitbook/assets/color-secondary-text.png) |
| Name | Dark Theme | Light Theme |
| :------------ | :-------------------------------------------------------- | :--------------------------------------------------- |
| Blue | ![](../../.gitbook/assets/color-dark-blue.webp) | ![](../../.gitbook/assets/color-blue.webp) |
| Green | ![](../../.gitbook/assets/color-dark-green.webp) | ![](../../.gitbook/assets/color-green.webp) |
| Magenta | ![](../../.gitbook/assets/color-dark-magenta.webp) | ![](../../.gitbook/assets/color-magenta.webp) |
| Orange | ![](../../.gitbook/assets/color-dark-orange.webp) | ![](../../.gitbook/assets/color-orange.webp) |
| Purple | ![](../../.gitbook/assets/color-dark-purple.webp) | ![](../../.gitbook/assets/color-purple.webp) |
| Red | ![](../../.gitbook/assets/color-dark-red.webp) | ![](../../.gitbook/assets/color-red.webp) |
| Yellow | ![](../../.gitbook/assets/color-dark-yellow.webp) | ![](../../.gitbook/assets/color-yellow.webp) |
| PrimaryText | ![](../../.gitbook/assets/color-dark-primary-text.webp) | ![](../../.gitbook/assets/color-primary-text.webp) |
| SecondaryText | ![](../../.gitbook/assets/color-dark-secondary-text.webp) | ![](../../.gitbook/assets/color-secondary-text.webp) |

## Types

Expand Down
12 changes: 6 additions & 6 deletions docs/api-reference/user-interface/detail.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Detail

![](../../.gitbook/assets/detail.png)
![](../../.gitbook/assets/detail.webp)

## API Reference

Expand Down Expand Up @@ -54,7 +54,7 @@ A Metadata view that will be shown in the right-hand-side of the `Detail`.

Use it to display additional structured data about the main content shown in the `Detail` view.

![Detail-metadata illustration](../../.gitbook/assets/detail-metadata.png)
![Detail-metadata illustration](../../.gitbook/assets/detail-metadata.webp)

#### Example

Expand Down Expand Up @@ -99,7 +99,7 @@ export default function Main() {

A single value with an optional icon.

![Detail-metadata-label illustration](../../.gitbook/assets/detail-metadata-label.png)
![Detail-metadata-label illustration](../../.gitbook/assets/detail-metadata-label.webp)

#### Example

Expand Down Expand Up @@ -138,7 +138,7 @@ export default function Main() {

An item to display a link.

![Detail-metadata-link illustration](../../.gitbook/assets/detail-metadata-link.png)
![Detail-metadata-link illustration](../../.gitbook/assets/detail-metadata-link.webp)

#### Example

Expand Down Expand Up @@ -177,7 +177,7 @@ export default function Main() {

A list of [`Tags`](detail.md#detail.metadata.taglist.item) displayed in a row.

![Detail-metadata-taglist illustration](../../.gitbook/assets/detail-metadata-taglist.png)
![Detail-metadata-taglist illustration](../../.gitbook/assets/detail-metadata-taglist.webp)

#### Example

Expand Down Expand Up @@ -226,7 +226,7 @@ A Tag in a `Detail.Metadata.TagList`.

A metadata item that shows a separator line. Use it for grouping and visually separating metadata items.

![](../../.gitbook/assets/detail-metadata-separator.png)
![](../../.gitbook/assets/detail-metadata-separator.webp)

```typescript
import { Detail } from "@raycast/api";
Expand Down
28 changes: 14 additions & 14 deletions docs/api-reference/user-interface/form.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Our `Form` component provides great user experience to collect some data from a user and submit it for extensions needs.

![](../../.gitbook/assets/example-doppler-share-secrets.png)
![](../../.gitbook/assets/example-doppler-share-secrets.webp)

## Two Types of Items: Controlled vs. Uncontrolled

Expand All @@ -20,7 +20,7 @@ Before submitting data, it is important to ensure all required form controls are

In Raycast, validation can be fully controlled from the API. To keep the same behavior as we have natively, the proper way of usage is to validate a `value` in the `onBlur` callback, update the `error` of the item and keep track of updates with the `onChange` callback to drop the `error` value. The [useForm](../../utils-reference/react-hooks/useForm.md) utils hook nicely wraps this behaviour and is the recommended way to do deal with validations.

![](../../.gitbook/assets/form-validation.png)
![](../../.gitbook/assets/form-validation.webp)

{% hint style="info" %}
Keep in mind that if the Form has any errors, the [`Action.SubmitForm`](./actions.md#action.submitform) `onSubmit` callback won't be triggered.
Expand Down Expand Up @@ -153,7 +153,7 @@ function validatePassword(value: string): boolean {

Drafts are a mechanism to preserve filled-in inputs (but not yet submitted) when an end-user exits the command. To enable this mechanism, set the `enableDrafts` prop on your Form and populate the initial values of the Form with the [top-level prop `draftValues`](../../information/lifecycle/README.md#launchprops).

![](../../.gitbook/assets/form-drafts.png)
![](../../.gitbook/assets/form-drafts.webp)

{% hint style="info" %}

Expand Down Expand Up @@ -265,7 +265,7 @@ Optionally add a [Form.LinkAccessory](form.md#form.linkaccessory) in the right-h

A form item with a text field for input.

![](../../.gitbook/assets/form-textfield.png)
![](../../.gitbook/assets/form-textfield.webp)

#### Example

Expand Down Expand Up @@ -333,7 +333,7 @@ export default function Command() {

A form item with a secure text field for password-entry in which the entered characters must be kept secret.

![](../../.gitbook/assets/form-password.png)
![](../../.gitbook/assets/form-password.webp)

#### Example

Expand Down Expand Up @@ -401,7 +401,7 @@ export default function Command() {

A form item with a text area for input. The item supports multiline text entry.

![](../../.gitbook/assets/form-textarea.png)
![](../../.gitbook/assets/form-textarea.webp)

#### Example

Expand Down Expand Up @@ -472,7 +472,7 @@ export default function Command() {

A form item with a checkbox.

![](../../.gitbook/assets/form-checkbox.png)
![](../../.gitbook/assets/form-checkbox.webp)

#### Example

Expand Down Expand Up @@ -540,7 +540,7 @@ export default function Command() {

A form item with a date picker.

![](../../.gitbook/assets/form-datepicker.png)
![](../../.gitbook/assets/form-datepicker.webp)

#### Example

Expand Down Expand Up @@ -640,7 +640,7 @@ export default function Command() {

A form item with a dropdown menu.

![](../../.gitbook/assets/form-dropdown.png)
![](../../.gitbook/assets/form-dropdown.webp)

#### Example

Expand Down Expand Up @@ -793,7 +793,7 @@ export default function Command() {

A form item with a tag picker that allows the user to select multiple items.

![](../../.gitbook/assets/form-tagpicker.png)
![](../../.gitbook/assets/form-tagpicker.webp)

#### Example

Expand Down Expand Up @@ -905,7 +905,7 @@ export default function Command() {

A form item that shows a separator line. Use for grouping and visually separating form items.

![](../../.gitbook/assets/form-separator.png)
![](../../.gitbook/assets/form-separator.webp)

#### Example

Expand Down Expand Up @@ -937,9 +937,9 @@ A form item with a button to open a dialog to pick some files and/or some direct
While the user picked some items that existed, it might be possible for them to be deleted or changed when the `onSubmit` callback is called. Hence you should always make sure that the items exist before acting on them!
{% endhint %}

![](../../.gitbook/assets/form-filepicker-multiple.png)
![](../../.gitbook/assets/form-filepicker-multiple.webp)

![Single Selection](../../.gitbook/assets/form-filepicker-single.png)
![Single Selection](../../.gitbook/assets/form-filepicker-single.webp)

#### Example

Expand Down Expand Up @@ -1080,7 +1080,7 @@ A form item with a simple text label.

Do _not_ use this component to show validation messages for other form fields.

![](../../.gitbook/assets/form-description.png)
![](../../.gitbook/assets/form-description.webp)

#### Example

Expand Down
8 changes: 4 additions & 4 deletions docs/api-reference/user-interface/grid.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Because its API tries to stick as closely to [List](list.md#list)'s as possible,
- finally, replacing all usages of `List` with `Grid`.
{% endhint %}

![](../../.gitbook/assets/grid.png)
![](../../.gitbook/assets/grid.webp)

## Search Bar

Expand Down Expand Up @@ -512,7 +512,7 @@ empty view alongside the other `Grid.Item`s.

Note that the `EmptyView` is _never_ displayed if the `Grid`'s `isLoading` property is true and the search bar is empty.

![Grid EmptyView illustration](../../.gitbook/assets/grid-empty-view.png)
![Grid EmptyView illustration](../../.gitbook/assets/grid-empty-view.webp)

#### Example

Expand Down Expand Up @@ -582,7 +582,7 @@ Sections can specify their own `columns`, `fit`, `aspectRatio` and `inset` props

#### Example

![](../../.gitbook/assets/grid-styled-sections.png)
![](../../.gitbook/assets/grid-styled-sections.webp)

{% tabs %}
{% tab title="GridWithSection.tsx" %}
Expand Down Expand Up @@ -645,7 +645,7 @@ export default function Command() {

An interface describing an accessory view in a `Grid.Item`.

![Grid.Item accessories illustration](../../.gitbook/assets/grid-item-accessories.png)
![Grid.Item accessories illustration](../../.gitbook/assets/grid-item-accessories.webp)

### Grid.Inset

Expand Down
Loading

0 comments on commit d2fb56c

Please sign in to comment.