Giter VIP home page Giter VIP logo

react-info-display's Introduction

react-info-display

Description

react-info-display is a simple npm library that provides utilities for logging messages and displaying them in a customizable log viewer component for React applications.

Installation

You can install react-info-display via npm:

npm install react-info-display

Usage

Displayer

The Displayer class allows you to log messages and subscribe to receive updates whenever a new message is logged.

import { InfoDisplay, displayer } from "react-info-display";

// Add a message
displayer.add("Hello, world!");

const [messages, setMessages] = useState<string[]>([]);
// Subscribe to messages updates
const msgCallback = (messages: string[]) => setMessages([...messages]);
displayer.subscribe(msgCallback);

// Unsubscribe from log updates
displayer.unsubscribe(msgCallback);

return (
  <div className="app">
    <h1>Info Display Example</h1>
    <InfoDisplay
      messages={messages}
      position={{ bottom: "10px", left: "10px", right: "20px" }} // Custom position
      size={{ width: "80%", height: "300px" }} // Custom size
      style={{
        // Custom styles
        backgroundColor: "#e0e0e0",
        fontFamily: "Courier New, monospace",
        fontSize: "14px",
        color: "#333",
      }}
    />
  </div>
);

InfoDisplay Component

The InfoDisplay component is a React component that displays messages in a scrollable view.

import React, { useEffect, useState } from "react";
import InfoDisplay from "./InfoDisplay";
import displayer from "./msgUtils";
import "./App.css";

const App: React.FC = () => {
  const [messages, setMessages] = useState<string[]>([]);

  useEffect(() => {
    const logCallback = (logs: string[]) => setMessages([...logs]);
    displayer.subscribe(logCallback);

    // Example logs
    displayer.log("Log message 1");
    displayer.log("Log message 2");
    displayer.log("Log message 3");

    return () => {
      displayer.unsubscribe(logCallback);
    };
  }, []);

  return (
    <div className="app">
      <h1>Info Display Example</h1>
      <InfoDisplay
        messages={messages}
        position={{ bottom: "10px", left: "10px", right: "20px" }} // Custom position
        size={{ width: "80%", height: "300px" }} // Custom size
        style={{
          // Custom styles
          backgroundColor: "#e0e0e0",
          fontFamily: "Courier New, monospace",
          fontSize: "14px",
          color: "#333",
        }}
      />
    </div>
  );
};

export default App;

InfoDisplay Props

  • messages: An array of strings representing the log messages to display.
  • position (optional): CSS properties to customize the position of the log viewer.
  • size (optional): CSS properties to customize the size of the log viewer.
  • style (optional): Additional CSS styles to apply to the log viewer.

Contribution

Contributions are welcome! Feel free to open issues or submit pull requests.

License

This project is licensed under the MIT License - see the LICENSE file for details.

react-info-display's People

Contributors

jeffreyc2017 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.