[CI Skip] 0.28.4

docs/ui-util/README.md

@@ -0,0 +1,28 @@
+
+@polkadot/ui-util
+=================
+
+Various utility and formatting functions
+
+formatBalance
+-------------
+
+```js
+const props = await api.rpc.system.properties();
+
+formatBalance.setDefaults({
+  decimals: props.tokenDecimals,
+  unit: props.tokenSymbol
+});
+
+formatBalance('12345'); // 12.345z DOT
+```
+
+calcSi
+------
+
+```js
+// calculates the SI unit applicable
+formatBalance.calcSi('12345'); // { power: 3, value: 'k', text: 'Kilo' }
+```
+