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

Update Button Documentation #1249

Merged
merged 5 commits into from
Dec 16, 2021

Conversation

rurikoaraki
Copy link
Collaborator

Platforms Impacted

  • iOS
  • macOS
  • win32 (Office)
  • windows
  • android

Description of changes

Updating documentation for base button

Verification

Build succeeds

Pull request checklist

This PR has considered (when applicable):

  • Automated Tests
  • Documentation and examples
  • Keyboard Accessibility
  • Voiceover
  • Internationalization and Right-to-left Layouts

/**
* A callback to call on button click event
*/
onClick?: () => void;
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This should change to onPress in the long run per #1035

@@ -87,18 +89,18 @@ export type ButtonProps = Omit<IWithPressableOptions<ViewProps>, 'onPress'> & {
*/
block?: boolean;

/**
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Comes as part of RN View props

@@ -91,7 +92,9 @@ export interface ButtonCorePropsWithInnerRef extends Omit<IWithPressableOptions<
*/
onClick?: () => void;

testID?: string;
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Comes as part of RN View props

@@ -76,6 +76,7 @@ export interface ButtonTokens extends ButtonCoreTokens {
export interface ButtonCorePropsWithInnerRef extends Omit<IWithPressableOptions<ViewProps>, 'onPress'> {
/*
* Text to show on the Button.
* Only used in FAB
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Should be removed soon, so just going to leave this comment instead making a whole type for it.

@rurikoaraki rurikoaraki merged commit 841d299 into microsoft:master Dec 16, 2021
@rurikoaraki rurikoaraki deleted the documentation_button branch January 6, 2022 21:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants