Skip to content

Commit

Permalink
docs: add new ADR about use onclick in breadcrumb component
Browse files Browse the repository at this point in the history
  • Loading branch information
denilsonrp committed Jul 14, 2023
1 parent 028b736 commit 4fd5bbb
Showing 1 changed file with 17 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
import { Meta } from '@storybook/addon-docs'

<Meta title="Docs/Architecture Decision Records/ADR 0009: Why use onClick event on breadcrumb component even undocumented?" />

# Why use `onClick` event on breadcrumb component even undocumented?

🗓️ 2023-07 · ✍️ [@denilsonrp](https://github.com/denilsonrp)

## Context

In the [breadcrumb component's pull request](https://github.com/juntossomosmais/atomium/pull/163) a [doubt arose about the correct functioning of the `onClick` event](https://github.com/juntossomosmais/atomium/pull/163#discussion_r1250986555), as this event isn't documented in [ion-breadcrumb docs](https://ionicframework.com/docs/api/breadcrumb#events).

## Decision

We ran some tests on Atomium's breadcrumb component in order to ensure the correct firing of the event and even though the `onClick` event isn't documented in the events section of the [ion-breadcrumb docs](https://ionicframework.com/docs/api/breadcrumb#events), the tests were successful and the event fired correctly.

Based on these tests, we can assume that, even without event documentation, it's possible to use it. The idea of ​​exposing this decision is to serve as a reference in possible similar scenarios in the future.

0 comments on commit 4fd5bbb

Please sign in to comment.