Skip to content
Rishi Bharadwaj Sai Lella edited this page Jul 1, 2024 · 1 revision

Basic-React-Light-Dark-Mode-Switcher wiki


Welcome to the official wiki page for Basic-React-Light-Dark-Mode-Switcher wiki!! Here you will find detailed information about the project, its components, usage instructions, and more.

Components

1. Navbar Component

The Navbar component provides navigation functionality for the application. It includes:

  • Navbar Brand: Displays the project name with a link to the homepage.
  • Navigation Links: Includes a link to the homepage and potentially other navigation items.
  • Dark Mode Toggle: Allows users to switch between light and dark modes for the application.
2. Textform Component

The Textform component offers text manipulation features. Key functionalities include:

  • Text Input: Allows users to enter text.
  • Case Conversion Buttons: Enables users to convert the entered text to uppercase or lowercase.
  • Text Summary: Displays statistics about the entered text, such as word count and character count.
3. Alert Component

The Alert component provides feedback messages to users. It includes:

  • Alert Types: Supports different alert types, such as warning, success, error, etc.
  • Customizable Props: Users can customize the alert message and appearance by passing props like code and msg.

Usage

  • Getting Started: Clone the repository and install dependencies using npm or yarn.
  • Running the Application: Start the development server and open http://localhost:5173 in your web browser.
  • Features: Explore the Navbar to switch between light and dark modes, use the Textform to manipulate text, and observe alerts based on user actions.

Technologies Used

  • React: JavaScript library for building user interfaces.
  • Bootstrap: CSS framework for styling components.
  • PropTypes: Library for typechecking props in React components.

Contribution Guidelines

We welcome contributions to improve and enhance this project. If you would like to contribute, please follow these guidelines:

  • Fork the repository and create a new branch for your feature or fix.
  • Make sure your code adheres to the existing coding style and conventions.
  • Submit a pull request with a clear description of your changes and why they are beneficial.

License

This project is licensed under the MIT License.

Security

For security-related concerns or to report vulnerabilities, please refer to the Security Policy.

Contact

For any questions, suggestions, or support regarding this project, feel free to reach out to us at [email protected].