summaryrefslogtreecommitdiffstats
path: root/devtools/client/accessibility/components/LearnMoreLink.js
blob: 2a21df4ea5c56210128e8c0e2d1d0a9b126a0ebe (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

"use strict";

const {
  Component,
} = require("resource://devtools/client/shared/vendor/react.js");
const PropTypes = require("resource://devtools/client/shared/vendor/react-prop-types.js");
const {
  p,
  a,
} = require("resource://devtools/client/shared/vendor/react-dom-factories.js");

const { openDocLink } = require("resource://devtools/client/shared/link.js");

/**
 * Localization friendly component for rendering a block of text with a "Learn more" link
 * as a part of it.
 */
class LearnMoreLink extends Component {
  static get propTypes() {
    return {
      className: PropTypes.string,
      href: PropTypes.string,
      learnMoreStringKey: PropTypes.string.isRequired,
      l10n: PropTypes.object.isRequired,
      messageStringKey: PropTypes.string.isRequired,
      onClick: PropTypes.func,
    };
  }

  static get defaultProps() {
    return {
      href: "#",
      learnMoreStringKey: null,
      l10n: null,
      messageStringKey: null,
      onClick: LearnMoreLink.openDocOnClick,
    };
  }

  static openDocOnClick(event) {
    event.preventDefault();
    openDocLink(event.target.href);
  }

  render() {
    const {
      className,
      href,
      learnMoreStringKey,
      l10n,
      messageStringKey,
      onClick,
    } = this.props;
    const learnMoreString = l10n.getStr(learnMoreStringKey);
    const messageString = l10n.getFormatStr(messageStringKey, learnMoreString);

    // Split the paragraph string with the link as a separator, and include the link into
    // results.
    const re = new RegExp(`(\\b${learnMoreString}\\b)`);
    const contents = messageString.split(re);
    contents[1] = a({ className: "link", href, onClick }, contents[1]);

    return p(
      {
        className,
      },
      ...contents
    );
  }
}

module.exports = LearnMoreLink;