3ae48af67c
This PR starts putting in place the high-level changes we want to make to the docs site. - It makes separate sections for Reference and Examples and Community. - Gets rid of the secondary sidebar and integrates it into the main sidebar. - Groups the reference articles by type. - Pulls in the examples alongside code and a live playground so people don't have to visit examples.tldraw.com separately. <img width="1458" alt="Screenshot 2024-01-30 at 09 43 46" src="https://github.com/tldraw/tldraw/assets/469604/4f5aa339-3a69-4d9b-9b9f-dfdddea623e8"> Again, this is the top-level changes and there's more to be done for the next PR(s): - create quick start page - clean up installation page - add accordion to Examples page prbly - put fun stuff in header (from footer) - landing page - something for landing page of API - search cmd-k and border - cleanup _sidebarReferenceContentLinks - external links _blank - address potential skew issue with code examples - have a link to other examples (next.js, etc.) ### Change Type - [x] `documentation` — Changes to the documentation only[^2] ### Test Plan 1. Make sure examples work! ### Release Notes - Rework our docs site to pull together the examples app and reference section more cohesively. --------- Co-authored-by: Taha <98838967+Taha-Hassan-Git@users.noreply.github.com> Co-authored-by: Steve Ruiz <steveruizok@gmail.com> Co-authored-by: Mitja Bezenšek <mitja.bezensek@gmail.com> Co-authored-by: alex <alex@dytry.ch> Co-authored-by: Lu Wilson <l2wilson94@gmail.com> Co-authored-by: Dan Groshev <git@dgroshev.com>
167 lines
No EOL
8.7 KiB
Text
167 lines
No EOL
8.7 KiB
Text
---
|
|
title: v2.0.0-beta.2
|
|
description: Examples
|
|
author: tldraw
|
|
date: 1/10/2024
|
|
order: 0
|
|
status: published
|
|
---
|
|
|
|
[View on GitHub](https://github.com/tldraw/tldraw/releases/tag/v2.0.0-beta.2)
|
|
|
|
|
|
#### Fix validation when pasting images. ([#2436](https://github.com/tldraw/tldraw/pull/2436))
|
|
|
|
- Fixes url validations.
|
|
|
|
#### Fix decrement button label in OnTheCanvas example component ([#2432](https://github.com/tldraw/tldraw/pull/2432))
|
|
|
|
- tiny bug fix, simply changing a label to match behaviour
|
|
|
|
#### refactor copy/export, fix safari copy-as-image being broken ([#2411](https://github.com/tldraw/tldraw/pull/2411))
|
|
|
|
- Fix a bug preventing copying as an image on iOS
|
|
|
|
#### Add url validation ([#2428](https://github.com/tldraw/tldraw/pull/2428))
|
|
|
|
- Add validation to urls.
|
|
|
|
#### [fix] next selected shapes comment ([#2427](https://github.com/tldraw/tldraw/pull/2427))
|
|
|
|
- Fix error in setStyleForNextSelectedShapes comment
|
|
|
|
#### annotate error boundary example ([#2410](https://github.com/tldraw/tldraw/pull/2410))
|
|
|
|
- Add annotation to error boundary example
|
|
|
|
#### Fix issues with clip paths for frames ([#2406](https://github.com/tldraw/tldraw/pull/2406))
|
|
|
|
- Add a brief release note for your PR here.
|
|
|
|
#### Annotate custom styles example ([#2405](https://github.com/tldraw/tldraw/pull/2405))
|
|
|
|
- Add annotation to the custom styles example
|
|
|
|
#### annotate custom config example ([#2404](https://github.com/tldraw/tldraw/pull/2404))
|
|
|
|
- Adds annotation to the custom config example with a bit more detail
|
|
|
|
#### annotate asset props, correct image/video confusion ([#2399](https://github.com/tldraw/tldraw/pull/2399))
|
|
|
|
- Annotates the asset props example and fixes a mistake in the existing comments
|
|
|
|
#### Annotate/refactor store events example ([#2400](https://github.com/tldraw/tldraw/pull/2400))
|
|
|
|
- Update store events example to use store.listen method
|
|
- Annotate with explanations of the code
|
|
|
|
#### annotate canvas events ([#2397](https://github.com/tldraw/tldraw/pull/2397))
|
|
|
|
- Adds annotation to the canvas events example
|
|
|
|
#### [fix] edge scrolling when component is inside of screen ([#2398](https://github.com/tldraw/tldraw/pull/2398))
|
|
|
|
- Add a brief release note for your PR here.
|
|
|
|
#### Annotate api example ([#2395](https://github.com/tldraw/tldraw/pull/2395))
|
|
|
|
- Annotate API example
|
|
|
|
#### [tech debt] Primitives renaming party / cleanup ([#2396](https://github.com/tldraw/tldraw/pull/2396))
|
|
|
|
- renames Vec2d to Vec
|
|
- renames Vec2dModel to VecModel
|
|
- renames Box2d to Box
|
|
- renames Box2dModel to BoxModel
|
|
- renames Matrix2d to Mat
|
|
- renames Matrix2dModel to MatModel
|
|
- removes unused primitive helpers
|
|
|
|
#### Refactor and document speech bubble example ([#2392](https://github.com/tldraw/tldraw/pull/2392))
|
|
|
|
- Add annotations to the speech bubble example
|
|
- Refactor code for clarity
|
|
|
|
#### Fix trademark links ([#2380](https://github.com/tldraw/tldraw/pull/2380))
|
|
|
|
- Fixes broken links in a number of docs files.
|
|
|
|
#### [fix] polygon bounds ([#2378](https://github.com/tldraw/tldraw/pull/2378))
|
|
|
|
- Fixed a bug with the bounds calculation for polygons.
|
|
|
|
#### Avoid importing `editor.css` twice ([#2373](https://github.com/tldraw/tldraw/pull/2373))
|
|
|
|
- Prevent importing `editor.css` twice which should help when debugging the styles via developer console.
|
|
|
|
#### Adding an image shape from a file the public folder ([#2370](https://github.com/tldraw/tldraw/pull/2370))
|
|
|
|
- Adds a simple image example.
|
|
|
|
---
|
|
|
|
#### 💥 Breaking Change
|
|
|
|
- `@tldraw/editor`, `@tldraw/tldraw`, `@tldraw/tlschema`
|
|
- [tech debt] Primitives renaming party / cleanup [#2396](https://github.com/tldraw/tldraw/pull/2396) ([@steveruizok](https://github.com/steveruizok))
|
|
|
|
#### 🚀 Enhancement
|
|
|
|
- Adding an image shape from a file the public folder [#2370](https://github.com/tldraw/tldraw/pull/2370) ([@MitjaBezensek](https://github.com/MitjaBezensek))
|
|
|
|
#### 🐛 Bug Fix
|
|
|
|
- Avoid importing `editor.css` twice [#2373](https://github.com/tldraw/tldraw/pull/2373) ([@MitjaBezensek](https://github.com/MitjaBezensek))
|
|
- VS Code bump 2.0.20 [#2371](https://github.com/tldraw/tldraw/pull/2371) ([@MitjaBezensek](https://github.com/MitjaBezensek))
|
|
- `@tldraw/tlschema`
|
|
- Fix validation when pasting images. [#2436](https://github.com/tldraw/tldraw/pull/2436) ([@MitjaBezensek](https://github.com/MitjaBezensek) [@SomeHats](https://github.com/SomeHats))
|
|
- `@tldraw/tldraw`
|
|
- refactor copy/export, fix safari copy-as-image being broken [#2411](https://github.com/tldraw/tldraw/pull/2411) ([@SomeHats](https://github.com/SomeHats) [@huppy-bot[bot]](https://github.com/huppy-bot[bot]))
|
|
- [fix] Asset versions [#2389](https://github.com/tldraw/tldraw/pull/2389) ([@steveruizok](https://github.com/steveruizok))
|
|
- `@tldraw/tldraw`, `@tldraw/tlschema`, `@tldraw/utils`, `@tldraw/validate`
|
|
- Add url validation [#2428](https://github.com/tldraw/tldraw/pull/2428) ([@MitjaBezensek](https://github.com/MitjaBezensek) [@SomeHats](https://github.com/SomeHats))
|
|
- `@tldraw/editor`
|
|
- Fix issues with clip paths for frames [#2406](https://github.com/tldraw/tldraw/pull/2406) ([@MitjaBezensek](https://github.com/MitjaBezensek))
|
|
- `@tldraw/editor`, `@tldraw/tldraw`
|
|
- [fix] edge scrolling when component is inside of screen [#2398](https://github.com/tldraw/tldraw/pull/2398) ([@steveruizok](https://github.com/steveruizok))
|
|
- [fix] polygon bounds [#2378](https://github.com/tldraw/tldraw/pull/2378) ([@steveruizok](https://github.com/steveruizok))
|
|
- `@tldraw/store`
|
|
- Fix meta examples [#2379](https://github.com/tldraw/tldraw/pull/2379) ([@steveruizok](https://github.com/steveruizok))
|
|
|
|
#### 🏠 Internal
|
|
|
|
- Fix license language. [#2365](https://github.com/tldraw/tldraw/pull/2365) ([@steveruizok](https://github.com/steveruizok))
|
|
|
|
#### 📝 Documentation
|
|
|
|
- Fix decrement button label in OnTheCanvas example component [#2432](https://github.com/tldraw/tldraw/pull/2432) ([@StanFlint](https://github.com/StanFlint))
|
|
- annotate error boundary example [#2410](https://github.com/tldraw/tldraw/pull/2410) ([@Taha-Hassan-Git](https://github.com/Taha-Hassan-Git) [@steveruizok](https://github.com/steveruizok))
|
|
- fix example scrolling on ios [#2412](https://github.com/tldraw/tldraw/pull/2412) ([@SomeHats](https://github.com/SomeHats))
|
|
- Add descriptions to active examples [#2407](https://github.com/tldraw/tldraw/pull/2407) ([@SomeHats](https://github.com/SomeHats))
|
|
- Annotate custom styles example [#2405](https://github.com/tldraw/tldraw/pull/2405) ([@Taha-Hassan-Git](https://github.com/Taha-Hassan-Git) [@steveruizok](https://github.com/steveruizok))
|
|
- annotate custom config example [#2404](https://github.com/tldraw/tldraw/pull/2404) ([@Taha-Hassan-Git](https://github.com/Taha-Hassan-Git))
|
|
- annotate asset props, correct image/video confusion [#2399](https://github.com/tldraw/tldraw/pull/2399) ([@Taha-Hassan-Git](https://github.com/Taha-Hassan-Git))
|
|
- Annotate/refactor store events example [#2400](https://github.com/tldraw/tldraw/pull/2400) ([@Taha-Hassan-Git](https://github.com/Taha-Hassan-Git))
|
|
- annotate canvas events [#2397](https://github.com/tldraw/tldraw/pull/2397) ([@Taha-Hassan-Git](https://github.com/Taha-Hassan-Git))
|
|
- Annotate api example [#2395](https://github.com/tldraw/tldraw/pull/2395) ([@Taha-Hassan-Git](https://github.com/Taha-Hassan-Git))
|
|
- Refactor and document speech bubble example [#2392](https://github.com/tldraw/tldraw/pull/2392) ([@Taha-Hassan-Git](https://github.com/Taha-Hassan-Git) [@steveruizok](https://github.com/steveruizok))
|
|
- Fix README link typo [#2372](https://github.com/tldraw/tldraw/pull/2372) ([@chunderbolt](https://github.com/chunderbolt))
|
|
- `@tldraw/editor`
|
|
- [fix] next selected shapes comment [#2427](https://github.com/tldraw/tldraw/pull/2427) ([@Taha-Hassan-Git](https://github.com/Taha-Hassan-Git))
|
|
- `@tldraw/tldraw`
|
|
- [example] Changing the default tldraw colors [#2402](https://github.com/tldraw/tldraw/pull/2402) ([@steveruizok](https://github.com/steveruizok))
|
|
- add descriptions to examples [#2375](https://github.com/tldraw/tldraw/pull/2375) ([@SomeHats](https://github.com/SomeHats) [@steveruizok](https://github.com/steveruizok))
|
|
- `@tldraw/assets`, `@tldraw/editor`, `@tldraw/tldraw`, `@tldraw/tlschema`, `@tldraw/utils`, `@tldraw/validate`
|
|
- Fix trademark links [#2380](https://github.com/tldraw/tldraw/pull/2380) ([@nonparibus](https://github.com/nonparibus))
|
|
- Another typo fix. [#2366](https://github.com/tldraw/tldraw/pull/2366) ([@steveruizok](https://github.com/steveruizok))
|
|
|
|
#### Authors: 8
|
|
|
|
- [@chunderbolt](https://github.com/chunderbolt)
|
|
- [@huppy-bot[bot]](https://github.com/huppy-bot[bot])
|
|
- alex ([@SomeHats](https://github.com/SomeHats))
|
|
- David @ HASH ([@nonparibus](https://github.com/nonparibus))
|
|
- Mitja Bezenšek ([@MitjaBezensek](https://github.com/MitjaBezensek))
|
|
- Stan Flint ([@StanFlint](https://github.com/StanFlint))
|
|
- Steve Ruiz ([@steveruizok](https://github.com/steveruizok))
|
|
- Taha ([@Taha-Hassan-Git](https://github.com/Taha-Hassan-Git)) |