Introduce experimental and legacy component status

[connor-baer]

Purpose

Legacy components enable us to evolve the codebase without being held back by problematic components that don't have a viable alternative yet. They are exported from @sumup/circuit-ui/legacy.

Experimental components enable us to test and refine the API of new components and lower the bar for contributions. They are exported from @sumup/circuit-ui/experimental.

Approach and changes

• Document the component lifecycle (preview)
• Mark the Tooltip, Sidebar and calendar components as legacy

Definition of done

• Development completed
• Reviewers assigned
• Unit and integration tests
• Meets minimum browser support
• Meets accessibility requirements

[changeset-bot]

🦋 Changeset detected

Latest commit: 4dab74c

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@sumup/circuit-ui	Major

Not sure what this means? Click here to learn what changesets are.

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

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
oss-circuit-ui	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 17, 2023 8:14am

[codecov]

Codecov Report

Merging #2094 (4dab74c) into next (9677a30) will decrease coverage by 0.04%.
The diff coverage is 84.61%.

@@            Coverage Diff             @@
##             next    #2094      +/-   ##
==========================================
- Coverage   96.91%   96.88%   -0.04%     
==========================================
  Files         258      258              
  Lines       23148    23186      +38     
  Branches     2160     2160              
==========================================
+ Hits        22434    22463      +29     
- Misses        707      715       +8     
- Partials        7        8       +1     

Impacted Files	Coverage Δ
.../circuit-ui/components/CalendarTag/CalendarTag.tsx	51.79% <0.00%> (-2.62%)	⬇️
...mponents/CalendarTagTwoStep/CalendarTagTwoStep.tsx	54.12% <0.00%> (+0.47%)	⬆️
...t-ui/components/Calendar/RangePickerController.tsx	48.64% <50.00%> (-2.78%)	⬇️
...ges/circuit-ui/components/Calendar/RangePicker.tsx	85.71% <100.00%> (-2.53%)	⬇️
...circuit-ui/components/Calendar/SingleDayPicker.tsx	100.00% <100.00%> (ø)
packages/circuit-ui/components/Sidebar/Sidebar.tsx	100.00% <100.00%> (ø)
packages/circuit-ui/components/Tooltip/Tooltip.tsx	100.00% <100.00%> (ø)

[robinmetral]

Excited to see the bundlephobia drop 😬

[robinmetral]

🎉

[robinmetral]

@connor-baer from our chat about #1677 (comment):

Basically when we release a new Tooltip (with Floating UI) it can be on the experimental namespace (@sumup/circuit-ui/experimental) or on the stable namespace (@sumup/circuit-ui), as long as the current Tooltip is moved to the legacy namespace (@sumup/circuit-ui/legacy). If the new Tooltip (with Floating UI) is stable, then we can also mark the old one as deprecated, but it would stay on the legacy namespace.

Maybe we can clarify that the "deprecated" status is an extra state that can apply to components on both the stable and legacy namespaces?