Giter Site home page Giter Site logo

adityasuman2025 / mngotexteditor Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 1.0 344 KB

A JavaScript Library (npm package ) to memic the design of Sublime Text Editor. One can easily create his web profile in react.js by installing mngo-text-editor package

Home Page: https://adityasuman.mngo.in

HTML 2.13% TypeScript 88.41% CSS 9.46%
editor javascript react text-editor

mngotexteditor's Introduction

mngo-text-editor

This library is available at mngo-text-editor

Demo

mngo.in

adityasuman.mngo.in

Brief:

A JavaScript Library (npm package) to memic the design of Sublime Text Editor. One can easily create his web profile in react.js by installing mngo-text-editor package

Screenshots:

screenshot 1

screenshot 2

Usage

<MNgoTextEditor
    titleBarHeight={string}
    tabBarHeight={string}
    filesListBarWidth={string}
    title={string}
    typeWriterText1={string}
    typeWriterText2={string}
    files={array}
    filesContent={object}
/>

props example

  1. titleBarHeight default value is "25px"

  2. tabBarHeight default value is "30px"

  3. filesListBarWidth default value is "220px"

  4. title "adityasuman2025"

  5. typeWriterText1 "Hello World" (html string)

  6. typeWriterText2 "This is Aditya Suman" (html string)

  7. files

         [
             {
                 "type": "folder", "srcKey": "adityasuman", "defaultOpen": true,
                 "files": [
                     { "type": "file", "srcKey": "about_me.html" },
                     { "type": "file", "srcKey": "contact_me.html" },
                     {
                         "type": "folder", "srcKey": "work_experience",
                         "files": [ ]
                     }
                 ]
             },
             { "type": "file", "srcKey": "follow_me.html" },
         ]
    
    1. type can be file or folder
    2. srcKey is the name of the file that will appear in left side bar and the same key is used in filesContent props to contain content of that file
  8. filesContent

         {
             "about_me.html": {
                 "title": "<About Me>",
                 "content": 'I\'m a programmer and a computer geek.<br>I have professional skill in Mobile & Web Application Development. <br>Currently I am Full Time Software Engineer at <a href="https://www.byjus.com/" target="_blank" class="title_a">Byjus</a> and have done internship at <b>ISRO, UpBrinGO & 4 other startups</b>.<br>Other than programming I use to spend time in reading novels, listening songs, graphics designing and nature photography.'
             },
         }
    
    1. key (about_me.html) is the srcKey from files props
    2. title is the title of the file (string)
    3. content is the content of the file (html string)

Installation

  1. npm install
  2. npm start

Available Scripts

In the project directory, you can run

npm start

Runs the app in the development mode Open http://localhost:3000 to view it in the browser.

npm run lib-build

it is for final package build which create dist folder.

npm run build-publish

this command make build of the project and publishes it, basically it is combination of npm run lib-build and npm publish

npm publish

to publish the project on npm

Note: do npm run lib-build before npm publish because it publishes dist folder as defined as key main, module, files in package.json, and do not forget to login in npm using npm login

License

All rights reserved under MNgo.

mngotexteditor's People

Contributors

adityasuman2025 avatar

Watchers

 avatar

Forkers

inncee81

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.