7 posts tagged with "JSDoc"

✨ Version 0.0.3​

#8105fdb refactor(authentication): update AuthContextProps type description

Updated the comment for the AuthContextProps type to provide a clearer explanation of its intended purpose. The new description focuses on the use of properties to store authentication-related state, replacing the previous note about generic parameter usage for onLogin. This clarification aims to enhance maintainability and comprehensibility of the code for future developers.

📕 Documentation​

#b6a08f4 docs(layout): add detailed documentation for Block component properties

This commit introduces a comprehensive documentation block for the Block component, detailing its purpose, usage example, and all props available. This enhancement aims to improve code readability and facilitate developers' understanding of the component's functionality and customization options.

📕 Navigation Documentation​

#44e612e docs(navigation): add README for navigation component

This commit introduces a README.md file for the navigation component in the React Native project. The document provides an overview of using grid layouts with Flexbox, outlines the enhancement of the Block component to support grid and layout styling, and lists necessary dependencies. Additionally, it includes a link to further documentation, aiding developers in understanding and utilizing the navigation components more effectively.

✨ Version 0.0.1​

#6737291 feat(navigation): add new withFancyDrawer component

This commit introduces a new navigation package within the project. It includes a high-order component, withFancyDrawer, which enhances components with animations and styles to simulate a fancy drawer effect. The new package is integrated into the project's structure via updates to the relevant package.json files and includes dependencies like expo-router and @react-navigation/drawer. This addition aims to improve UI interactivity and aesthetics by providing smooth drawer transitions in React Native applications.

#80ff097 refactor(inputs): update theme handling and optimize component imports

This commit includes the following changes:

• Theme context usage updated to simplify access to theming properties by removing .colors where applicable.
• Reorganized and optimized import paths and component structures, including moving input-adornment.tsx logic to input-icon.tsx for better cohesion.
• Introduction of new components such as InputIcon, HelperText, and ActionContainer to enhance code modularity and readability.
• Improved styling logic through adjustments to constants and styles definitions, focusing on consistency across components.
• Deletion of obsolete components that have been refactored elsewhere in the project. These updates aim to streamline the codebase, reduce redundancy, and improve the overall maintainability of the input components.

#b409a8c docs(bottom-sheet): enhance documentation strings for components and types

Updated the JSDoc comments in the BottomSheet component files to improve clarity and provide detailed descriptions of each method and property. The changes include adding more explicit type declarations, refining existing descriptions, and ensuring consistency throughout the documentation. These updates aim to facilitate better understanding and usability of the code for future developers and maintainers. No functional logic was altered.

#23fa66a refactor(skeleton-loading): improve documentation and restructure imports

Updated the skeleton-loading package to version 0.0.2, enhancing the documentation for better clarity and understanding. Moved dev dependencies from peerDependencies in package.json. Clarified comments and added detailed JSDoc annotations throughout the code to make it more maintainable and comprehensible. This refactor does not introduce any breaking changes or affect functionality but improves code readability and developer experience.