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.

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(input, input-number, input-text): api consistency across components #6634

Merged

Conversation

geospatialem
Copy link
Member

Related Issue: n/a

Summary

Document API consistency across components, in particular while working through the new component, textarea. cc: #5644

Update includes consistency with input, input-number, and input-text (in alignment with textarea) for the following:

  1. autofocus prop:

When true, the component is focused on page load. Only one element can contain autofocus. If multiple elements have autofocus, the first element will receive focus.

  1. selectText() method:

Selects the text of the component's value.

@geospatialem geospatialem requested a review from a team as a code owner March 22, 2023 22:03
@geospatialem geospatialem self-assigned this Mar 22, 2023
@github-actions github-actions bot added the docs Issues relating to documentation updates only. label Mar 22, 2023
Copy link
Member

@jcfranco jcfranco left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💥

@@ -99,7 +99,7 @@ export class InputNumber
@Prop({ reflect: true }) alignment: Position = "start";

/**
* When `true`, the component is focused on page load.
* When `true`, the component is focused on page load. Only one element can contain `autofocus`. If multiple elements have `autofocus`, the first element will receive focus.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

@geospatialem geospatialem merged commit 53c94a2 into master Mar 23, 2023
@geospatialem geospatialem deleted the geospatialem/docs-input-component-api-consistency branch March 23, 2023 13:54
benelan added a commit that referenced this pull request Mar 27, 2023
…ocus-revert

* origin/master: (30 commits)
  fix(modal): prevent error when calling setFocus on a recently rendered and opened modal (`dist-custom-elements`) (#6666)
  fix(tile-select): fix click not firing in custom-elements build (#6665)
  fix(card): provide more meaningful screen reader label for selectable cards (deprecates `deselect` message override) (#6657)
  fix(pagination): add current page information for screen readers (#6637)
  chore: update jsbin sample to CC 1.0 breaking changes and latest jsapi version (#6651)
  feat(text-area): add calcite-text-area component (#5644)
  chore(release): 1.1.1-next.2
  fix(tile): adds styling to `tile` where `link` is present for additional distinction (#6628)
  docs(input, input-number, input-text): api consistency across components (#6634)
  docs(accordion-item): add actions-start and actions-end slots (#6631)
  docs(modal): kebab-case slot names and sticky context (#6625)
  chore(release): 1.1.1-next.1
  fix: restore form control validation in Safari (#6623)
  chore(linting): fix linting errors (#6613)
  build(deps): Bump eslint-plugin-react from 7.31.11 to 7.32.2 (#6619)
  build(deps): Bump eslint from 8.35.0 to 8.36.0 (#6620)
  build(deps): Bump @types/lodash-es from 4.17.6 to 4.17.7 (#6621)
  build: fix peer dependency resolution error (#6611)
  ci: update user-defined priority (#6609)
  build: update browserslist db (#6527)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Issues relating to documentation updates only.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants