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

Documentation and Naming Consistency Fixes #11

Closed
carl0smat3us opened this issue Oct 1, 2023 · 0 comments
Closed

Documentation and Naming Consistency Fixes #11

carl0smat3us opened this issue Oct 1, 2023 · 0 comments

Comments

@carl0smat3us
Copy link
Contributor

carl0smat3us commented Oct 1, 2023

Issue Description:

The main class of this library is named "OtpInput," but in the documentation, it is occasionally referred to as "OTPInput," creating inconsistencies. Additionally, there is an error in the documentation structure where certain properties should be nested within the "theme" property.

Issue Details:

  • Naming Issue: The main class of the library is named "OtpInput," but the documentation mentions it as "OTPInput" in some places. This creates confusion and inconsistency in the documentation.

  • Documentation Structure Error: The documentation presents an incorrect structure for configuring the component. Certain properties should be grouped within the "theme" property for better organization and clarity.

Current Documentation Snippet:

<OTPInput
  numberOfDigits={6}
  focusColor="green"
  onTextChange={(text) => console.log(text)}
  containerStyle={styles.container}
  inputsContainerStyle={styles.inputsContainer}
  pinCodeContainerStyle={styles.pinCodeContainer}
  pinCodeTextStyle={styles.pinCodeText}
  focusStickStyle={styles.focusStick}
  focusStickBlinkingDuration={500}
/>

Proposed Correction:

<OtpInput
  numberOfDigits={6}
  onTextChange={(text) => console.log(text)}
  focusColor: "green"
  focusStickBlinkingDuration: 500
  theme={{
    containerStyle: styles.container,
    inputsContainerStyle: styles.inputsContainer,
    pinCodeContainerStyle: styles.pinCodeContainer,
    pinCodeTextStyle: styles.pinCodeText,
    focusStickStyle: styles.focusStick
  }}
@carl0smat3us carl0smat3us changed the title Improve Issue Report and Provide a Name Documentation and Naming Consistency Fixes Oct 1, 2023
@anday013 anday013 closed this as completed Oct 6, 2023
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

No branches or pull requests

2 participants