Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add convention for property values #9185

Merged
merged 3 commits into from
Apr 26, 2024
Merged

docs: add convention for property values #9185

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
14ce9ab
chore: add convention for property values
driskull Apr 24, 2024
01aff01
Update README.md
driskull Apr 25, 2024
05f9829
Update README.md
driskull Apr 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions packages/calcite-components/conventions/README.md
View file
Open in desktop
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.
driskull marked this conversation as resolved.
Show resolved Hide resolved

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
Loading