tldraw/packages
Lu[ke] Wilson b1569c97e0
add docs for TLShapeUtil (#1215)
This PR adds docs for the methods in the TLShapeUtil class.
I think that it's a good page to have docs on, as it shows people what's
possible with the custom shape API.

Currently, our docs are not showing `@param` info for lots of methods,
including the ones added in this PR.
I'll do fix for that in a follow-up PR, so that it's easier to review.

---

Note: Moving forward, we probably want to consider **_where_** these
docs are shown, and how we achieve that.

For example, do we put the docs for these methods in:
* The docs page for the `TLShapeUtil` class?
* The docs pages for the handler types, eg:
[`OnResizeHandler`](http://localhost:3000/gen/editor/OnResizeHandler-type)?
* Both?

Right now, I opted for putting them in the the TLShapeUtil class, as it
keeps them all in one place, and it's what we already do for some
others.

We should consider both - what works best for the docs? and what works
best for code editors?

---

This PR also includes a fix to our pre-commit step that @SomeHats did.
2023-05-05 14:05:25 +00:00
..
assets New vite-based examples app (#1226) 2023-05-05 13:10:36 +00:00
editor add docs for TLShapeUtil (#1215) 2023-05-05 14:05:25 +00:00
file-format readmes 2023-05-04 13:47:56 +01:00
polyfills readmes 2023-05-04 13:47:56 +01:00
primitives readmes 2023-05-04 13:47:56 +01:00
tldraw New vite-based examples app (#1226) 2023-05-05 13:10:36 +00:00
tlschema readmes 2023-05-04 13:47:56 +01:00
tlstore readmes 2023-05-04 13:47:56 +01:00
tlsync-client readmes 2023-05-04 13:47:56 +01:00
tlvalidate readmes 2023-05-04 13:47:56 +01:00
ui New vite-based examples app (#1226) 2023-05-05 13:10:36 +00:00
utils readmes 2023-05-04 13:47:56 +01:00