Skip to content

Commit

Permalink
docs: add v18 migration guide
Browse files Browse the repository at this point in the history
  • Loading branch information
DSil committed Nov 19, 2024
1 parent 28626e8 commit 343031a
Show file tree
Hide file tree
Showing 10 changed files with 29 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: v18
description: How to migrate to Orbit 18.0.0
redirect_from:
- /migration-guides/v18/
---

# Orbit Migration Guide v18

This migration guide focuses on the process of migrating from Orbit v17 to v18.0, as some breaking changes were introduced.
With this guide, we aim to walk through all the breaking changes and how they can be addressed, allowing the migration to be smoother and effortlessly.

## Breaking changes

### Seat component

#### `title` and `description` props no longer have default values

These props are used to give additional context to the rendered SVG element that visually represents the seat. They are not rendered on the screen, but are announced by screen readers.

The previous default values were not meaningful and could lead to wrong or misleading information.

As they are announced by screen readers, they should have meaningful and translated text.

#### `label` and `price` props now only accept string

These props used to accept React nodes as well, but this could result in some unexpected or wrong HTML structure.

Therefore, these props now only accept strings.

0 comments on commit 343031a

Please sign in to comment.