docs: add api guidelines doc

[joshblack]

No description provided.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 20de8b1

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[github-actions]

size-limit report 📦

Path	Size
packages/react/dist/browser.esm.js	103.03 KB (0%)
packages/react/dist/browser.umd.js	103.31 KB (0%)

[joshblack]

Couple of ideas:

• Prefer interface to type to avoid never from intersections

  type A = { value: number };
  type B = A & { value: string };
  // B['value'] == never
  
  interface C { value: number }
  interface D extends C { value: string } // <- Types of property 'value' are incompatible

• Prefer React.HTMLAttributes<HTMLElement> over React.ComponentPropsWithoutRef unless element type is a part of public API

  • Allows generic spread on outermost element so that you can change element type over time

[hectahertz]

We have these in SelectPanel and we can't use the useControllableState hook and make them optional because the format is non-standard (extra arguments on the functions). It might be good to be a bit more specific to avoid this in the future :)

[hectahertz]

This won't be really that necessary unless we have some very specific needs after the React Compiler, so maybe we can skip it?

[hectahertz]

Also I'd like for us to talk about prop spread: it gets really convoluted and hard to know what we actually surface. SelectPanel is a good example.

[joshblack]

Great point 👍