Skip to content

Commit

Permalink
docs: add convention for property values (#9185)
Browse files Browse the repository at this point in the history
**Related Issue:** N/A

## Summary

add convention for property values
  • Loading branch information
driskull authored Apr 26, 2024
1 parent d529a10 commit 45d5294
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions packages/calcite-components/conventions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,12 @@ There are a few ways to add event listeners within our components:

Private/internal properties should be annotated accordingly to avoid exposing them in the doc and/or API. You can do this by using the `@private`/`@internal` [JSDoc](https://jsdoc.app/) tags.

### Property values

Property values should be meaningful. Avoid using values such as "default" for default values. Instead, use a more descriptive value.

For instance: `placement: "start" | "end" = "start";` is preferred to `placement: "default" | "end" = "default";`

### Reflecting to attributes

It is recommended to reflect properties that fit the following criteria:
Expand Down

0 comments on commit 45d5294

Please sign in to comment.