PrivateCoffee/tldraw
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1
tldraw/packages/assets/selfHosted.js

244 lines
15 KiB
JavaScript
Raw Normal View History

Asset improvements (#1557) This PR does the following: - Add `selfHosted.js`, which is a great option for users that wish to self host the assets. Works well for both self hosting from the public folder or via a CDN. - Updates the docs for assets. We now have a dedicated page for assets where all the options are more clearly explained. I also removed the assets explanation from the main docs as the unpkg option should work out of the box and setting up the assets is no longer necessary. - Cleaned up the `refresh-assets` script. We now use common `types.d.ts` file to define our types. All the other options then reuse them. - Pulled out the `formatAssetUrl` into it's own file. It's now static an no longer generated. - `urls.d.ts`, `import.d.ts`, and newly added `selfhosted.d.ts` are now also no longer generated as we can import the types from `types.d.ts`. - You can now pass a subset of `assetUrls` to `<Tldraw />` and it will override the default option with the passed in overrides. This makes it easy to only customizes certain assets (only change the draw font as an example). ### Change Type - [x] `patch` — Bug Fix
2023-06-09 11:43:01 +00:00
// This file is automatically generated by scripts/refresh-assets.ts.
// Do not edit manually.
// eslint-disable-next-line @typescript-eslint/triple-slash-reference
/// <reference path="./modules.d.ts" />
import { formatAssetUrl } from './utils.js'
/**
* @param {AssetUrlOptions} [opts]
* @public
*/
export function getAssetUrls(opts) {
return {
fonts: {
monospace: formatAssetUrl('./fonts/IBMPlexMono-Medium.woff2', opts),
sansSerif: formatAssetUrl('./fonts/IBMPlexSans-Medium.woff2', opts),
serif: formatAssetUrl('./fonts/IBMPlexSerif-Medium.woff2', opts),
draw: formatAssetUrl('./fonts/Shantell_Sans-Normal-SemiBold.woff2', opts),
},
icons: {
'align-bottom-center': formatAssetUrl('./icons/icon/align-bottom-center.svg', opts),
'align-bottom-left': formatAssetUrl('./icons/icon/align-bottom-left.svg', opts),
'align-bottom-right': formatAssetUrl('./icons/icon/align-bottom-right.svg', opts),
'align-bottom': formatAssetUrl('./icons/icon/align-bottom.svg', opts),
'align-center-center': formatAssetUrl('./icons/icon/align-center-center.svg', opts),
'align-center-horizontal': formatAssetUrl('./icons/icon/align-center-horizontal.svg', opts),
'align-center-left': formatAssetUrl('./icons/icon/align-center-left.svg', opts),
'align-center-right': formatAssetUrl('./icons/icon/align-center-right.svg', opts),
'align-center-vertical': formatAssetUrl('./icons/icon/align-center-vertical.svg', opts),
'align-left': formatAssetUrl('./icons/icon/align-left.svg', opts),
'align-right': formatAssetUrl('./icons/icon/align-right.svg', opts),
'align-top-center': formatAssetUrl('./icons/icon/align-top-center.svg', opts),
'align-top-left': formatAssetUrl('./icons/icon/align-top-left.svg', opts),
'align-top-right': formatAssetUrl('./icons/icon/align-top-right.svg', opts),
'align-top': formatAssetUrl('./icons/icon/align-top.svg', opts),
'arrow-left': formatAssetUrl('./icons/icon/arrow-left.svg', opts),
'arrowhead-arrow': formatAssetUrl('./icons/icon/arrowhead-arrow.svg', opts),
'arrowhead-bar': formatAssetUrl('./icons/icon/arrowhead-bar.svg', opts),
'arrowhead-diamond': formatAssetUrl('./icons/icon/arrowhead-diamond.svg', opts),
'arrowhead-dot': formatAssetUrl('./icons/icon/arrowhead-dot.svg', opts),
'arrowhead-none': formatAssetUrl('./icons/icon/arrowhead-none.svg', opts),
'arrowhead-square': formatAssetUrl('./icons/icon/arrowhead-square.svg', opts),
'arrowhead-triangle-inverted': formatAssetUrl(
'./icons/icon/arrowhead-triangle-inverted.svg',
opts
),
'arrowhead-triangle': formatAssetUrl('./icons/icon/arrowhead-triangle.svg', opts),
'aspect-ratio': formatAssetUrl('./icons/icon/aspect-ratio.svg', opts),
avatar: formatAssetUrl('./icons/icon/avatar.svg', opts),
blob: formatAssetUrl('./icons/icon/blob.svg', opts),
'bring-forward': formatAssetUrl('./icons/icon/bring-forward.svg', opts),
'bring-to-front': formatAssetUrl('./icons/icon/bring-to-front.svg', opts),
check: formatAssetUrl('./icons/icon/check.svg', opts),
'checkbox-checked': formatAssetUrl('./icons/icon/checkbox-checked.svg', opts),
'checkbox-empty': formatAssetUrl('./icons/icon/checkbox-empty.svg', opts),
'chevron-down': formatAssetUrl('./icons/icon/chevron-down.svg', opts),
'chevron-left': formatAssetUrl('./icons/icon/chevron-left.svg', opts),
'chevron-right': formatAssetUrl('./icons/icon/chevron-right.svg', opts),
'chevron-up': formatAssetUrl('./icons/icon/chevron-up.svg', opts),
'chevrons-ne': formatAssetUrl('./icons/icon/chevrons-ne.svg', opts),
'chevrons-sw': formatAssetUrl('./icons/icon/chevrons-sw.svg', opts),
'clipboard-copied': formatAssetUrl('./icons/icon/clipboard-copied.svg', opts),
'clipboard-copy': formatAssetUrl('./icons/icon/clipboard-copy.svg', opts),
code: formatAssetUrl('./icons/icon/code.svg', opts),
collab: formatAssetUrl('./icons/icon/collab.svg', opts),
color: formatAssetUrl('./icons/icon/color.svg', opts),
comment: formatAssetUrl('./icons/icon/comment.svg', opts),
'cross-2': formatAssetUrl('./icons/icon/cross-2.svg', opts),
cross: formatAssetUrl('./icons/icon/cross.svg', opts),
'dash-dashed': formatAssetUrl('./icons/icon/dash-dashed.svg', opts),
'dash-dotted': formatAssetUrl('./icons/icon/dash-dotted.svg', opts),
'dash-draw': formatAssetUrl('./icons/icon/dash-draw.svg', opts),
'dash-solid': formatAssetUrl('./icons/icon/dash-solid.svg', opts),
discord: formatAssetUrl('./icons/icon/discord.svg', opts),
'distribute-horizontal': formatAssetUrl('./icons/icon/distribute-horizontal.svg', opts),
'distribute-vertical': formatAssetUrl('./icons/icon/distribute-vertical.svg', opts),
dot: formatAssetUrl('./icons/icon/dot.svg', opts),
'dots-horizontal': formatAssetUrl('./icons/icon/dots-horizontal.svg', opts),
'dots-vertical': formatAssetUrl('./icons/icon/dots-vertical.svg', opts),
'drag-handle-dots': formatAssetUrl('./icons/icon/drag-handle-dots.svg', opts),
duplicate: formatAssetUrl('./icons/icon/duplicate.svg', opts),
edit: formatAssetUrl('./icons/icon/edit.svg', opts),
'external-link': formatAssetUrl('./icons/icon/external-link.svg', opts),
file: formatAssetUrl('./icons/icon/file.svg', opts),
'fill-none': formatAssetUrl('./icons/icon/fill-none.svg', opts),
'fill-pattern': formatAssetUrl('./icons/icon/fill-pattern.svg', opts),
'fill-semi': formatAssetUrl('./icons/icon/fill-semi.svg', opts),
'fill-solid': formatAssetUrl('./icons/icon/fill-solid.svg', opts),
follow: formatAssetUrl('./icons/icon/follow.svg', opts),
following: formatAssetUrl('./icons/icon/following.svg', opts),
'font-draw': formatAssetUrl('./icons/icon/font-draw.svg', opts),
'font-mono': formatAssetUrl('./icons/icon/font-mono.svg', opts),
'font-sans': formatAssetUrl('./icons/icon/font-sans.svg', opts),
'font-serif': formatAssetUrl('./icons/icon/font-serif.svg', opts),
'geo-arrow-down': formatAssetUrl('./icons/icon/geo-arrow-down.svg', opts),
'geo-arrow-left': formatAssetUrl('./icons/icon/geo-arrow-left.svg', opts),
'geo-arrow-right': formatAssetUrl('./icons/icon/geo-arrow-right.svg', opts),
'geo-arrow-up': formatAssetUrl('./icons/icon/geo-arrow-up.svg', opts),
'geo-check-box': formatAssetUrl('./icons/icon/geo-check-box.svg', opts),
Add cloud shape (#1708) ![Kapture 2023-07-04 at 16 36 31](https://github.com/tldraw/tldraw/assets/1242537/bcb19959-ac66-46fa-92ea-50fe4692a96c) ### Change Type - [x] `minor` — New feature [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version ### Test Plan 1. Make some cloud shapes, try different sizes, colors, fills. 2. Export cloud shapes to images. - [ ] Unit Tests - [ ] End to end tests ### Release Notes - Adds a cloud shape.
2023-07-07 15:32:08 +00:00
'geo-cloud': formatAssetUrl('./icons/icon/geo-cloud.svg', opts),
Asset improvements (#1557) This PR does the following: - Add `selfHosted.js`, which is a great option for users that wish to self host the assets. Works well for both self hosting from the public folder or via a CDN. - Updates the docs for assets. We now have a dedicated page for assets where all the options are more clearly explained. I also removed the assets explanation from the main docs as the unpkg option should work out of the box and setting up the assets is no longer necessary. - Cleaned up the `refresh-assets` script. We now use common `types.d.ts` file to define our types. All the other options then reuse them. - Pulled out the `formatAssetUrl` into it's own file. It's now static an no longer generated. - `urls.d.ts`, `import.d.ts`, and newly added `selfhosted.d.ts` are now also no longer generated as we can import the types from `types.d.ts`. - You can now pass a subset of `assetUrls` to `<Tldraw />` and it will override the default option with the passed in overrides. This makes it easy to only customizes certain assets (only change the draw font as an example). ### Change Type - [x] `patch` — Bug Fix
2023-06-09 11:43:01 +00:00
'geo-diamond': formatAssetUrl('./icons/icon/geo-diamond.svg', opts),
'geo-ellipse': formatAssetUrl('./icons/icon/geo-ellipse.svg', opts),
'geo-hexagon': formatAssetUrl('./icons/icon/geo-hexagon.svg', opts),
'geo-octagon': formatAssetUrl('./icons/icon/geo-octagon.svg', opts),
'geo-oval': formatAssetUrl('./icons/icon/geo-oval.svg', opts),
'geo-pentagon': formatAssetUrl('./icons/icon/geo-pentagon.svg', opts),
'geo-rectangle': formatAssetUrl('./icons/icon/geo-rectangle.svg', opts),
'geo-rhombus-2': formatAssetUrl('./icons/icon/geo-rhombus-2.svg', opts),
'geo-rhombus': formatAssetUrl('./icons/icon/geo-rhombus.svg', opts),
'geo-star': formatAssetUrl('./icons/icon/geo-star.svg', opts),
'geo-trapezoid': formatAssetUrl('./icons/icon/geo-trapezoid.svg', opts),
'geo-triangle': formatAssetUrl('./icons/icon/geo-triangle.svg', opts),
'geo-x-box': formatAssetUrl('./icons/icon/geo-x-box.svg', opts),
github: formatAssetUrl('./icons/icon/github.svg', opts),
group: formatAssetUrl('./icons/icon/group.svg', opts),
hidden: formatAssetUrl('./icons/icon/hidden.svg', opts),
image: formatAssetUrl('./icons/icon/image.svg', opts),
'info-circle': formatAssetUrl('./icons/icon/info-circle.svg', opts),
leading: formatAssetUrl('./icons/icon/leading.svg', opts),
link: formatAssetUrl('./icons/icon/link.svg', opts),
'lock-small': formatAssetUrl('./icons/icon/lock-small.svg', opts),
lock: formatAssetUrl('./icons/icon/lock.svg', opts),
menu: formatAssetUrl('./icons/icon/menu.svg', opts),
minus: formatAssetUrl('./icons/icon/minus.svg', opts),
mixed: formatAssetUrl('./icons/icon/mixed.svg', opts),
pack: formatAssetUrl('./icons/icon/pack.svg', opts),
page: formatAssetUrl('./icons/icon/page.svg', opts),
plus: formatAssetUrl('./icons/icon/plus.svg', opts),
'question-mark-circle': formatAssetUrl('./icons/icon/question-mark-circle.svg', opts),
'question-mark': formatAssetUrl('./icons/icon/question-mark.svg', opts),
redo: formatAssetUrl('./icons/icon/redo.svg', opts),
'reset-zoom': formatAssetUrl('./icons/icon/reset-zoom.svg', opts),
'rotate-ccw': formatAssetUrl('./icons/icon/rotate-ccw.svg', opts),
'rotate-cw': formatAssetUrl('./icons/icon/rotate-cw.svg', opts),
ruler: formatAssetUrl('./icons/icon/ruler.svg', opts),
search: formatAssetUrl('./icons/icon/search.svg', opts),
'send-backward': formatAssetUrl('./icons/icon/send-backward.svg', opts),
'send-to-back': formatAssetUrl('./icons/icon/send-to-back.svg', opts),
'settings-horizontal': formatAssetUrl('./icons/icon/settings-horizontal.svg', opts),
'settings-vertical-1': formatAssetUrl('./icons/icon/settings-vertical-1.svg', opts),
'settings-vertical': formatAssetUrl('./icons/icon/settings-vertical.svg', opts),
'share-1': formatAssetUrl('./icons/icon/share-1.svg', opts),
'share-2': formatAssetUrl('./icons/icon/share-2.svg', opts),
'size-extra-large': formatAssetUrl('./icons/icon/size-extra-large.svg', opts),
'size-large': formatAssetUrl('./icons/icon/size-large.svg', opts),
'size-medium': formatAssetUrl('./icons/icon/size-medium.svg', opts),
'size-small': formatAssetUrl('./icons/icon/size-small.svg', opts),
'spline-cubic': formatAssetUrl('./icons/icon/spline-cubic.svg', opts),
'spline-line': formatAssetUrl('./icons/icon/spline-line.svg', opts),
'stack-horizontal': formatAssetUrl('./icons/icon/stack-horizontal.svg', opts),
'stack-vertical': formatAssetUrl('./icons/icon/stack-vertical.svg', opts),
'stretch-horizontal': formatAssetUrl('./icons/icon/stretch-horizontal.svg', opts),
'stretch-vertical': formatAssetUrl('./icons/icon/stretch-vertical.svg', opts),
'text-align-center': formatAssetUrl('./icons/icon/text-align-center.svg', opts),
'text-align-justify': formatAssetUrl('./icons/icon/text-align-justify.svg', opts),
'text-align-left': formatAssetUrl('./icons/icon/text-align-left.svg', opts),
'text-align-right': formatAssetUrl('./icons/icon/text-align-right.svg', opts),
'tool-arrow': formatAssetUrl('./icons/icon/tool-arrow.svg', opts),
'tool-embed': formatAssetUrl('./icons/icon/tool-embed.svg', opts),
'tool-eraser': formatAssetUrl('./icons/icon/tool-eraser.svg', opts),
'tool-frame': formatAssetUrl('./icons/icon/tool-frame.svg', opts),
'tool-hand': formatAssetUrl('./icons/icon/tool-hand.svg', opts),
'tool-highlight': formatAssetUrl('./icons/icon/tool-highlight.svg', opts),
'tool-laser': formatAssetUrl('./icons/icon/tool-laser.svg', opts),
'tool-line': formatAssetUrl('./icons/icon/tool-line.svg', opts),
'tool-media': formatAssetUrl('./icons/icon/tool-media.svg', opts),
'tool-note': formatAssetUrl('./icons/icon/tool-note.svg', opts),
'tool-pencil': formatAssetUrl('./icons/icon/tool-pencil.svg', opts),
'tool-pointer': formatAssetUrl('./icons/icon/tool-pointer.svg', opts),
'tool-text': formatAssetUrl('./icons/icon/tool-text.svg', opts),
trash: formatAssetUrl('./icons/icon/trash.svg', opts),
'triangle-down': formatAssetUrl('./icons/icon/triangle-down.svg', opts),
'triangle-up': formatAssetUrl('./icons/icon/triangle-up.svg', opts),
twitter: formatAssetUrl('./icons/icon/twitter.svg', opts),
undo: formatAssetUrl('./icons/icon/undo.svg', opts),
ungroup: formatAssetUrl('./icons/icon/ungroup.svg', opts),
'unlock-small': formatAssetUrl('./icons/icon/unlock-small.svg', opts),
unlock: formatAssetUrl('./icons/icon/unlock.svg', opts),
'vertical-align-center': formatAssetUrl('./icons/icon/vertical-align-center.svg', opts),
'vertical-align-end': formatAssetUrl('./icons/icon/vertical-align-end.svg', opts),
'vertical-align-start': formatAssetUrl('./icons/icon/vertical-align-start.svg', opts),
visible: formatAssetUrl('./icons/icon/visible.svg', opts),
'warning-triangle': formatAssetUrl('./icons/icon/warning-triangle.svg', opts),
'zoom-in': formatAssetUrl('./icons/icon/zoom-in.svg', opts),
'zoom-out': formatAssetUrl('./icons/icon/zoom-out.svg', opts),
},
translations: {
ar: formatAssetUrl('./translations/ar.json', opts),
ca: formatAssetUrl('./translations/ca.json', opts),
da: formatAssetUrl('./translations/da.json', opts),
de: formatAssetUrl('./translations/de.json', opts),
en: formatAssetUrl('./translations/en.json', opts),
es: formatAssetUrl('./translations/es.json', opts),
fa: formatAssetUrl('./translations/fa.json', opts),
fi: formatAssetUrl('./translations/fi.json', opts),
fr: formatAssetUrl('./translations/fr.json', opts),
gl: formatAssetUrl('./translations/gl.json', opts),
he: formatAssetUrl('./translations/he.json', opts),
'hi-in': formatAssetUrl('./translations/hi-in.json', opts),
hu: formatAssetUrl('./translations/hu.json', opts),
it: formatAssetUrl('./translations/it.json', opts),
ja: formatAssetUrl('./translations/ja.json', opts),
'ko-kr': formatAssetUrl('./translations/ko-kr.json', opts),
ku: formatAssetUrl('./translations/ku.json', opts),
languages: formatAssetUrl('./translations/languages.json', opts),
main: formatAssetUrl('./translations/main.json', opts),
my: formatAssetUrl('./translations/my.json', opts),
ne: formatAssetUrl('./translations/ne.json', opts),
no: formatAssetUrl('./translations/no.json', opts),
pl: formatAssetUrl('./translations/pl.json', opts),
'pt-br': formatAssetUrl('./translations/pt-br.json', opts),
'pt-pt': formatAssetUrl('./translations/pt-pt.json', opts),
ro: formatAssetUrl('./translations/ro.json', opts),
ru: formatAssetUrl('./translations/ru.json', opts),
sv: formatAssetUrl('./translations/sv.json', opts),
te: formatAssetUrl('./translations/te.json', opts),
th: formatAssetUrl('./translations/th.json', opts),
tr: formatAssetUrl('./translations/tr.json', opts),
uk: formatAssetUrl('./translations/uk.json', opts),
vi: formatAssetUrl('./translations/vi.json', opts),
'zh-cn': formatAssetUrl('./translations/zh-cn.json', opts),
'zh-tw': formatAssetUrl('./translations/zh-tw.json', opts),
},
embedIcons: {
codepen: formatAssetUrl('./embed-icons/codepen.png', opts),
codesandbox: formatAssetUrl('./embed-icons/codesandbox.png', opts),
excalidraw: formatAssetUrl('./embed-icons/excalidraw.png', opts),
felt: formatAssetUrl('./embed-icons/felt.png', opts),
figma: formatAssetUrl('./embed-icons/figma.png', opts),
github_gist: formatAssetUrl('./embed-icons/github_gist.png', opts),
google_calendar: formatAssetUrl('./embed-icons/google_calendar.png', opts),
google_maps: formatAssetUrl('./embed-icons/google_maps.png', opts),
google_slides: formatAssetUrl('./embed-icons/google_slides.png', opts),
observable: formatAssetUrl('./embed-icons/observable.png', opts),
replit: formatAssetUrl('./embed-icons/replit.png', opts),
scratch: formatAssetUrl('./embed-icons/scratch.png', opts),
spotify: formatAssetUrl('./embed-icons/spotify.png', opts),
tldraw: formatAssetUrl('./embed-icons/tldraw.png', opts),
vimeo: formatAssetUrl('./embed-icons/vimeo.png', opts),
youtube: formatAssetUrl('./embed-icons/youtube.png', opts),
},
}
}
Reference in a new issue Copy permalink