Socket
Socket
Sign inDemoInstall

react-diffy

Package Overview
Dependencies
7
Maintainers
1
Versions
2
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    react-diffy

Output differences between inputs, ready for css styling


Version published
Maintainers
1
Created

Readme

Source

react-diffy

Output differences between two strings in a stylable form.

Based on react-diff which is based on react-diff. Uses the diff module.

Installation

npm install react-diffy

Usage

Pass text to compare as props.inputA and props.inputB:

import React, {Component} from 'react';
import Diff from 'react-diffy';

class MyComponent extends Component {
  render() {
    return (
      <Diff inputA="worst" inputB="blurst" />
    );
  }
}

You can also specify different values in props.type to compare in different ways. Valid values are 'chars', 'words', 'sentences' and 'json':

import React, {Component} from 'react';
import Diff from 'react-diffy';

class MyComponent extends Component {
  render() {
    return (
      <Diff type="words"
        inputA="It was the worst of times"
        inputB="It was the blurst of times" />
    );
  }
}

Styling

Outputs standard <ins> and <del> tags so you will at least have the browser default styling for these. On my browser they appear crossed-out or underlined.

You will probably want to add your own styles to look all fancy.

The output is wrapped in a div with class 'Difference' so you can attach all your style rules to that. You can override this class with props.className if you like.

Here are some styles that might work:

.Difference {
  font-family: monospace;
}

.Difference > del {
  background-color: rgb(255, 224, 224);
  text-decoration: none;
}

.Difference > ins {
  background-color: rgb(201, 238, 211);
  text-decoration: none;
}

Example

import React, {Component} from 'react';
import Diff from 'react-diffy';

class MyComponent extends Component {
  render() {
    return (
      <Diff inputA="worst" inputB="blurst" type="chars" />
    );
  }
}

License

MIT

Keywords

FAQs

Last updated on 27 Jan 2018

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc