Git Product home page Git Product logo

vue-richtext's Introduction

Vue component for rich content strings

npm last version Dependabot status

This library provides a simple vue component to render text with rich placeholder replacements. The parameters that are replaced can either be a string or an object that allows rendering any Vue component into the text. Placeholders are wrapped in brackets, like {placeholder}. Markdown can be used for basic text formatting.

Installation

npm install --save @juliushaertl/vue-richtext

Basic usage with simple text placeholders

  • Input string: The file {file} was added…
  • Arguments:
    • file: 'MyDocument'
  • Renders: The file 'MyDocument' was added…

Usage with vue components

  • Input string: The file {file} was added by {username}
  • Arguments:
    • file: 'MyDocument'
    • username: { component: User, props: { username: 'Jane Doe' }
  • Renders: The file 'MyDocument' was added by <User>Jane Doe</User>

Usage with markdown

  • Input string: The **file** *{file}* was added by {username}
  • Arguments:
    • file: 'MyDocument'
    • username: { component: User, props: { username: 'Jane Doe' }
  • Renders: The <strong>file</strong> <i>'MyDocument'</i> was added by <User>Jane Doe</User>

Documentation

A full example is shown in the documentation

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.