From 7eabfe94af07f544e6a9be4a78cb762e1a095b1b Mon Sep 17 00:00:00 2001
From: JuliaSvinareva <Julia.Svinaryova@onlyoffice.com>
Date: Tue, 13 Jul 2021 14:43:54 +0300
Subject: [PATCH] Hint Manager: add example usage

---
 apps/common/main/lib/component/HintManager.js | 53 +++++++++++++++++++
 1 file changed, 53 insertions(+)

diff --git a/apps/common/main/lib/component/HintManager.js b/apps/common/main/lib/component/HintManager.js
index 0010918b2..b97fbb8cf 100644
--- a/apps/common/main/lib/component/HintManager.js
+++ b/apps/common/main/lib/component/HintManager.js
@@ -38,6 +38,59 @@
  *
  */
 
+/**
+ *  Example usage with simple items:
+ *
+ *      <button ... data-hint="1" data-hint-direction="right" data-hint-offset="big" data-hint-title="B">...</button>
+ *      <label ... data-hint="1" data-hint-direction="bottom" data-hint-offset="medium" data-hint-title="L">...</label>
+ *
+ *  Example usage with components:
+ *
+ *      new Common.UI.Button({
+ *          ...
+ *          dataHint: '1',                  // '0' - tabs in toolbar, left and right menu, statusbar;
+ *                                          // '1' - file menu, contents of toolbar tabs, contents of right and left panels
+ *          dataHintDirection: 'bottom',    // top, bottom, right, left, left-top
+ *          dataHintOffset: 'small',        // big - 6px, medium - 4px, small - 2px
+ *          dataHintTitle : 'S'
+ *      });
+ *
+ *      new Common.UI.CheckBox({
+ *          ...
+ *          dataHint: '1',
+ *          dataHintDirection: 'left',
+ *          dataHintOffset: 'small'
+ *      });
+ *
+ *      new Common.UI.ComboBox({
+ *          ...
+ *          dataHint: '1',
+ *          dataHintDirection: 'bottom',
+ *          dataHintOffset: 'big'
+ *      });
+ *
+ *      new Common.UI.InputField({
+ *          ...
+ *          dataHint: '1',
+ *          dataHintDirection: 'left',
+ *          dataHintOffset: 'small'
+ *      });
+ *
+ *      new Common.UI.MetricSpinner({
+ *          ...
+ *          dataHint: '1',
+ *          dataHintDirection: 'bottom',
+ *          dataHintOffset: 'big'
+ *      });
+ *
+ *      new Common.UI.RadioBox({
+ *          ...
+ *          dataHint: '1',
+ *          dataHintDirection: 'left',
+ *          dataHintOffset: 'small'
+ *      });
+ */
+
 
 if (Common === undefined)
     var Common = {};