c893a02878
Highlighter is autolocked, so we shouldn't show the lock icon ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version ### Test Plan 1. Add a step-by-step description of how to test your PR here. 2. - [ ] Unit Tests - [ ] End to end tests ### Release Notes - We no longer show the tool lock option for highlighter - it didn't do anything anyway
253 lines
8.4 KiB
Text
253 lines
8.4 KiB
Text
---
|
|
title: matchUrl
|
|
status: published
|
|
category: editor
|
|
group: Function
|
|
author: api
|
|
date: 06/23/2023
|
|
order: 84
|
|
---<Small>Public Function</Small>
|
|
|
|
|
|
|
|
|
|
##### Parameters
|
|
|
|
|
|
<ParametersTable>
|
|
|
|
<ParametersTableRow>
|
|
<ParametersTableName>
|
|
|
|
`url`
|
|
|
|
</ParametersTableName>
|
|
<ParametersTableDescription>
|
|
|
|
```ts
|
|
string
|
|
```
|
|
|
|
|
|
|
|
</ParametersTableDescription>
|
|
</ParametersTableRow>
|
|
</ParametersTable>
|
|
|
|
##### Returns
|
|
|
|
|
|
```ts
|
|
| {
|
|
definition:
|
|
| {
|
|
readonly type: 'codepen'
|
|
readonly title: 'Codepen'
|
|
readonly hostnames: readonly ['codepen.io']
|
|
readonly minWidth: 300
|
|
readonly minHeight: 300
|
|
readonly width: 520
|
|
readonly height: 400
|
|
readonly doesResize: true
|
|
readonly canUnmount: false
|
|
readonly toEmbedUrl: (url: string) => string | undefined
|
|
readonly fromEmbedUrl: (url: string) => string | undefined
|
|
}
|
|
| {
|
|
readonly type: 'codesandbox'
|
|
readonly title: 'CodeSandbox'
|
|
readonly hostnames: readonly ['codesandbox.io']
|
|
readonly minWidth: 300
|
|
readonly minHeight: 300
|
|
readonly width: 720
|
|
readonly height: 500
|
|
readonly doesResize: true
|
|
readonly canUnmount: false
|
|
readonly toEmbedUrl: (url: string) => string | undefined
|
|
readonly fromEmbedUrl: (url: string) => string | undefined
|
|
}
|
|
| {
|
|
readonly type: 'excalidraw'
|
|
readonly title: 'Excalidraw'
|
|
readonly hostnames: readonly ['excalidraw.com']
|
|
readonly width: 720
|
|
readonly height: 500
|
|
readonly doesResize: true
|
|
readonly canUnmount: false
|
|
readonly isAspectRatioLocked: true
|
|
readonly toEmbedUrl: (url: string) => string | undefined
|
|
readonly fromEmbedUrl: (url: string) => string | undefined
|
|
}
|
|
| {
|
|
readonly type: 'felt'
|
|
readonly title: 'Felt'
|
|
readonly hostnames: readonly ['felt.com']
|
|
readonly width: 720
|
|
readonly height: 500
|
|
readonly doesResize: true
|
|
readonly canUnmount: false
|
|
readonly toEmbedUrl: (url: string) => string | undefined
|
|
readonly fromEmbedUrl: (url: string) => string | undefined
|
|
}
|
|
| {
|
|
readonly type: 'figma'
|
|
readonly title: 'Figma'
|
|
readonly hostnames: readonly ['figma.com']
|
|
readonly width: 720
|
|
readonly height: 500
|
|
readonly doesResize: true
|
|
readonly canUnmount: true
|
|
readonly toEmbedUrl: (url: string) => string | undefined
|
|
readonly fromEmbedUrl: (url: string) => string | undefined
|
|
}
|
|
| {
|
|
readonly type: 'github_gist'
|
|
readonly title: 'GitHub Gist'
|
|
readonly hostnames: readonly ['gist.github.com']
|
|
readonly width: 720
|
|
readonly height: 500
|
|
readonly doesResize: true
|
|
readonly canUnmount: true
|
|
readonly toEmbedUrl: (url: string) => string | undefined
|
|
readonly fromEmbedUrl: (url: string) => string | undefined
|
|
}
|
|
| {
|
|
readonly type: 'google_calendar'
|
|
readonly title: 'Google Calendar'
|
|
readonly hostnames: readonly ['calendar.google.*']
|
|
readonly width: 720
|
|
readonly height: 500
|
|
readonly minWidth: 460
|
|
readonly minHeight: 360
|
|
readonly doesResize: true
|
|
readonly canUnmount: false
|
|
readonly instructionLink: 'https://support.google.com/calendar/answer/41207?hl=en'
|
|
readonly toEmbedUrl: (url: string) => string | undefined
|
|
readonly fromEmbedUrl: (url: string) => string | undefined
|
|
}
|
|
| {
|
|
readonly type: 'google_maps'
|
|
readonly title: 'Google Maps'
|
|
readonly hostnames: readonly ['google.*']
|
|
readonly width: 720
|
|
readonly height: 500
|
|
readonly doesResize: true
|
|
readonly canUnmount: false
|
|
readonly toEmbedUrl: (url: string) => string | undefined
|
|
readonly fromEmbedUrl: (url: string) => string | undefined
|
|
}
|
|
| {
|
|
readonly type: 'google_slides'
|
|
readonly title: 'Google Slides'
|
|
readonly hostnames: readonly ['docs.google.*']
|
|
readonly width: 720
|
|
readonly height: 500
|
|
readonly minWidth: 460
|
|
readonly minHeight: 360
|
|
readonly doesResize: true
|
|
readonly canUnmount: false
|
|
readonly toEmbedUrl: (url: string) => string | undefined
|
|
readonly fromEmbedUrl: (url: string) => string | undefined
|
|
}
|
|
| {
|
|
readonly type: 'observable'
|
|
readonly title: 'Observable'
|
|
readonly hostnames: readonly ['observablehq.com']
|
|
readonly width: 720
|
|
readonly height: 500
|
|
readonly doesResize: true
|
|
readonly canUnmount: false
|
|
readonly isAspectRatioLocked: false
|
|
readonly backgroundColor: '#fff'
|
|
readonly toEmbedUrl: (url: string) => string | undefined
|
|
readonly fromEmbedUrl: (url: string) => string | undefined
|
|
}
|
|
| {
|
|
readonly type: 'replit'
|
|
readonly title: 'Replit'
|
|
readonly hostnames: readonly ['replit.com']
|
|
readonly width: 720
|
|
readonly height: 500
|
|
readonly doesResize: true
|
|
readonly canUnmount: false
|
|
readonly toEmbedUrl: (url: string) => string | undefined
|
|
readonly fromEmbedUrl: (url: string) => string | undefined
|
|
}
|
|
| {
|
|
readonly type: 'scratch'
|
|
readonly title: 'Scratch'
|
|
readonly hostnames: readonly ['scratch.mit.edu']
|
|
readonly width: 520
|
|
readonly height: 400
|
|
readonly doesResize: false
|
|
readonly canUnmount: false
|
|
readonly toEmbedUrl: (url: string) => string | undefined
|
|
readonly fromEmbedUrl: (url: string) => string | undefined
|
|
}
|
|
| {
|
|
readonly type: 'spotify'
|
|
readonly title: 'Spotify'
|
|
readonly hostnames: readonly ['open.spotify.com']
|
|
readonly width: 720
|
|
readonly height: 500
|
|
readonly minHeight: 500
|
|
readonly overrideOutlineRadius: 12
|
|
readonly doesResize: true
|
|
readonly canUnmount: false
|
|
readonly toEmbedUrl: (url: string) => string | undefined
|
|
readonly fromEmbedUrl: (url: string) => string | undefined
|
|
}
|
|
| {
|
|
readonly type: 'tldraw'
|
|
readonly title: 'tldraw'
|
|
readonly hostnames: readonly [
|
|
'beta.tldraw.com',
|
|
'lite.tldraw.com',
|
|
'www.tldraw.com'
|
|
]
|
|
readonly minWidth: 300
|
|
readonly minHeight: 300
|
|
readonly width: 720
|
|
readonly height: 500
|
|
readonly doesResize: true
|
|
readonly canUnmount: true
|
|
readonly toEmbedUrl: (url: string) => string | undefined
|
|
readonly fromEmbedUrl: (url: string) => string | undefined
|
|
}
|
|
| {
|
|
readonly type: 'vimeo'
|
|
readonly title: 'Vimeo'
|
|
readonly hostnames: readonly ['vimeo.com', 'player.vimeo.com']
|
|
readonly width: 640
|
|
readonly height: 360
|
|
readonly doesResize: true
|
|
readonly canUnmount: false
|
|
readonly isAspectRatioLocked: true
|
|
readonly toEmbedUrl: (url: string) => string | undefined
|
|
readonly fromEmbedUrl: (url: string) => string | undefined
|
|
}
|
|
| {
|
|
readonly type: 'youtube'
|
|
readonly title: 'YouTube'
|
|
readonly hostnames: readonly [
|
|
'*.youtube.com',
|
|
'youtube.com',
|
|
'youtu.be'
|
|
]
|
|
readonly width: 800
|
|
readonly height: 450
|
|
readonly doesResize: true
|
|
readonly canUnmount: false
|
|
readonly overridePermissions: {
|
|
readonly 'allow-presentation': true
|
|
}
|
|
readonly isAspectRatioLocked: true
|
|
readonly toEmbedUrl: (url: string) => string | undefined
|
|
readonly fromEmbedUrl: (url: string) => string | undefined
|
|
}
|
|
embedUrl: string
|
|
url: string
|
|
}
|
|
| undefined
|
|
```
|
|
|