mantikafasi
/
ittai
forked from Ittai/ittai
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity Pipelines

Probably final structure of the docs

aa/multi-mod-support
Kyza 2021-01-27 11:14:37 -05:00
parent 393a94c8af
commit 6708657ad0
No known key found for this signature in database
GPG Key ID: 4CDDED9862F80924
51 changed files with 12516 additions and 465 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
core/reactComponents/FontAwesome.js → core/components/FontAwesome.js
View File

@ -1,17 +1,17 @@
import { React } from "../webpack/libraries";
/**
* Render any {@link https://fontawesome.com/|FontAwesome} icon.
* @component
* @example
* <FontAwesome type="brand" name="discord" size="22" />
export /**
* Render any {@link https://fontawesome.com/|FontAwesome} icon. This includes FontAwesome Pro icons.
* @param {object} props React properties.
* @param {string} [props.type="solid"] The FontAwesome icon type. `solid`, `regular`, `light`, `duotone`, `brand`.
* @param {number} props.size The size of the icon in pixels. Don't include `px`.
* @param {string} props.className {@link https://fontawesome.com/how-to-use/on-the-web/styling/duotone-icons|For extra class features that aren't directly supported.}
* @category reactComponents
*/
export function FontAwesome(props) {
* @param {string} [props.className=""] {@link https://fontawesome.com/how-to-use/on-the-web/styling/duotone-icons|For extra class features that aren't directly supported.}
* @memberof module:components
* @example
* return (
* <FontAwesome type="brand" name="discord" size="22" />
* );
*/ function FontAwesome(props) {
return (
<i
className={`fa${props.type?.[0] ? props.type[0].toLowerCase() : "s"} fa-${

5
core/reactComponents/index.js → core/components/index.js
View File

@ -1,8 +1,5 @@
/**
* @module reactComponents
* @module components
*/
/**
* @see FontAwesome
*/
export const FontAwesome = import("./FontAwesome");

4
core/utils/index.js
View File

@ -7,11 +7,11 @@
let clientMod;
/**
* @see module:patcher
* @see module:utils/patcher
*/
export const patcher = import("./patcher");
/**
* @see module:logger
* @see module:utils/logger
*/
export const logger = import("./logger");

3
core/utils/logger.js
View File

@ -1,6 +1,5 @@
/**
* @module logger
* @category utils
* @module utils/logger
*/
const cc = { ...console };

8
core/utils/patcher.js
View File

@ -1,6 +1,5 @@
/**
* @module patcher
* @category utils
* @module utils/patcher
*/
import logger from "./logger";
@ -62,17 +61,16 @@ export function unpatchAll(unpatches = patches) {
* @param {string} functionName The name of the function to patch.
* @param {string} type The type of patch to apply. `before`, `instead`, `after`.
* @param {function} patchFunction The code to patch into the function.
* @returns {object} {@link module:patcher.patch~patchData}
* @returns {object} {@link module:utils/patcher.patch~patchData}
*/
export function patch(name, object, functionName, type, patchFunction) {
if (!object.__ittai__) object.__ittai__ = {};
/**
* @namespace
* @memberof module:utils/patcher
* @prop {string} name The name of the function being patched.
* @prop {string} type The type of the patch.
* @prop {function} patchFunction The original function.
* @prop {function} unpatch The function to call to unpatch.
* @category utils.patcher.patch
*/
const patchData = {
name,

7
core/webpack/classes.js
View File

@ -1,6 +1,5 @@
/**
* @module classes
* @category webpack
* @module webpack/classes
*/
import { updateModules } from "./modules";
@ -32,8 +31,10 @@ export function getAllClassesFromModule(module) {
/**
* Gets a Webpack module from Discord by the class names.
* @param {...string} names
* @param {...string} names The names of the classes.
* @returns {Object}
* @example
* ittai.webpack.classes.getByNames("message", "cozyMessage");
*/
export function getByNames(...names) {
for (const mod of all()) {

3
core/webpack/components.js
View File

@ -1,6 +1,5 @@
/**
* @module components
* @category webpack
* @module webpack/components
*/
import { updateModules } from "./modules";

6
core/webpack/index.js
View File

@ -3,14 +3,14 @@
*/
/**
* @see module:modules
* @see module:webpack/modules
*/
export const modules = import("./modules");
/**
* @see module:components
* @see module:webpack/components
*/
export const components = import("./components");
/**
* @see module:classes
* @see module:webpack/classes
*/
export const classes = import("./classes");

5
core/webpack/modules.js
View File

@ -1,6 +1,5 @@
/**
* @module modules
* @category webpack
* @module webpack/modules
*/
const webpackID = "_ittai";
@ -12,6 +11,8 @@ updateModules();
* Gets a Webpack module from Discord by its property names.
* @param {...string} names
* @returns {Object}
* @example
* ittai.webpack.modules.getByProps("useState", "useRef");
*/
export function getByProps(...props) {
for (const mod of all()) {

2
docs/FontAwesome.html
View File

@ -83,7 +83,7 @@
<nav>
<h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Modules</h3><ul><li><a href="module-entities.html">entities</a></li><li><a href="module-libraries.html">libraries</a></li><li><a href="module-reactComponents.html">reactComponents</a></li><li><a href="module-utils.html">utils</a></li><li><a href="module-webpack.html">webpack</a></li></ul></div><div class="category"><h2>reactComponents</h2><h3>Components</h3><ul><li><a href="FontAwesome.html">FontAwesome</a></li></ul></div><div class="category"><h2>utils</h2><h3>Modules</h3><ul><li><a href="module-logger.html">logger</a></li><li><a href="module-patcher.html">patcher</a></li></ul></div><div class="category"><h2>utils.patcher.patch</h2><h3>Namespaces</h3><ul><li><a href="module-patcher.patch-patchData.html">patchData</a></li></ul></div><div class="category"><h2>webpack</h2><h3>Modules</h3><ul><li><a href="module-classes.html">classes</a></li><li><a href="module-components.html">components</a></li><li><a href="module-modules.html">modules</a></li></ul></div>
<h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Modules</h3><ul><li><a href="module-entities.html">entities</a></li><li><a href="module-libraries.html">libraries</a></li><li><a href="module-reactComponents.html">reactComponents</a></li><li><a href="module-utils.html">utils</a></li><li><a href="module-utils_logger.html">utils/logger</a></li><li><a href="module-utils_patcher.html">utils/patcher</a></li><li><a href="module-webpack.html">webpack</a></li><li><a href="module-webpack_classes.html">webpack/classes</a></li><li><a href="module-webpack_components.html">webpack/components</a></li><li><a href="module-webpack_modules.html">webpack/modules</a></li></ul></div><div class="category"><h2>ReactComponents</h2><h3>Components</h3><ul><li><a href="FontAwesome.html">FontAwesome</a></li></ul></div>
</nav>
</div>

58
docs/components_FontAwesome.js.html
View File

@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title> components/FontAwesome.js</title>
<title>Ittai components/FontAwesome.js</title>
<script src="https://cdn.jsdelivr.net/gh/google/code-prettify@master/loader/run_prettify.js"></script>
<script src="https://unpkg.com/@babel/standalone/babel.min.js"></script>
@ -21,7 +21,7 @@
<link type="text/css" rel="stylesheet" href="https://jmblog.github.io/color-themes-for-google-code-prettify/themes/tomorrow-night.min.css">
<link type="text/css" rel="stylesheet" href="styles/app.min.css">
<link type="text/css" rel="stylesheet" href="styles/iframe.css">
<link type="text/css" rel="stylesheet" href="">
<link type="text/css" rel="stylesheet" href="jsdoc.css">
<script async defer src="https://buttons.github.io/buttons.js"></script>
@ -42,6 +42,10 @@
</a>
<div class="logo">
<a href="index.html">
<h1 class="navbar-item">Ittai Documentation</h1>
</a>
</div>
<div class="menu">
@ -54,6 +58,15 @@
API Documentation
</a>
<a
class="link user-link "
href="https://github.com/Kyza/ittai"
>
GitHub
</a>
</div>
@ -66,9 +79,13 @@
id="sidebarNav"
>
<div class="search-wrapper">
<input id="search" type="text" placeholder="Search docs..." class="input">
</div>
<nav>
<h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Classes</h3><ul><li><a href="components.html">components</a></li></ul><h3>Global</h3><ul><li><a href="global.html#FontAwesome">FontAwesome</a></li><li><a href="global.html#getClientMod">getClientMod</a></li><li><a href="global.html#Plugin">Plugin</a></li></ul></div>
<h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Modules</h3><ul><li><a href="module-components.html">components</a></li><li><a href="module-entities.html">entities</a></li><li><a href="module-libraries.html">libraries</a></li><li><a href="module-utils.html">utils</a></li><li><a href="module-utils_logger.html">utils/logger</a></li><li><a href="module-utils_patcher.html">utils/patcher</a></li><li><a href="module-webpack.html">webpack</a></li><li><a href="module-webpack_classes.html">webpack/classes</a></li><li><a href="module-webpack_components.html">webpack/components</a></li><li><a href="module-webpack_modules.html">webpack/modules</a></li></ul></div>
</nav>
</div>
@ -85,17 +102,20 @@
<section>
<article>
<pre class="prettyprint source linenums"><code>import { getByProps } from "../webpack/modules";
const React = getByProps("useState");
<pre class="prettyprint source linenums"><code>import { React } from "../webpack/libraries";
/**
*
* @param {object} props - React properties.
* @param {string} props.type - The FontAwesome icon type. `solid`, `regular`, `light`, `duotone`, `brand`.
* @param {string} props.className - {@link https://fontawesome.com/how-to-use/on-the-web/styling/duotone-icons|For extra class features that aren't directly supported.}
* @param {number} props.size - The size of the icon in pixels. Don't include `px`.
*/
export function FontAwesome(props) {
export /**
* Render any {@link https://fontawesome.com/|FontAwesome} icon. This includes FontAwesome Pro icons.
* @param {object} props React properties.
* @param {string} [props.type="solid"] The FontAwesome icon type. `solid`, `regular`, `light`, `duotone`, `brand`.
* @param {number} props.size The size of the icon in pixels. Don't include `px`.
* @param {string} [props.className=""] {@link https://fontawesome.com/how-to-use/on-the-web/styling/duotone-icons|For extra class features that aren't directly supported.}
* @memberof module:components
* @example
* return (
* &lt;FontAwesome type="brand" name="discord" size="22" />
* );
*/ function FontAwesome(props) {
return (
&lt;i
className={`fa${props.type?.[0] ? props.type[0].toLowerCase() : "s"} fa-${
@ -114,16 +134,6 @@ export function FontAwesome(props) {
</div>
<footer class="footer">
<div class="content has-text-centered">
<p>Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a></p>
<p class="sidebar-created-by">
<a href="https://github.com/SoftwareBrothers/better-docs" target="_blank">BetterDocs theme</a> provided with <i class="fas fa-heart"></i> by
<a href="http://softwarebrothers.co" target="_blank">SoftwareBrothers - JavaScript Development Agency</a>
</p>
</div>
</footer>
</div>
<div id="side-nav" class="side-nav">
</div>
@ -132,5 +142,7 @@ export function FontAwesome(props) {
<script>PR.prettyPrint();</script>
<script src="scripts/linenumber.js"> </script>
<script src="scripts/search.js"> </script>
</body>
</html>

47
docs/components_index.js.html
View File

@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title> components/index.js</title>
<title>Ittai components/index.js</title>
<script src="https://cdn.jsdelivr.net/gh/google/code-prettify@master/loader/run_prettify.js"></script>
<script src="https://unpkg.com/@babel/standalone/babel.min.js"></script>
@ -21,7 +21,7 @@
<link type="text/css" rel="stylesheet" href="https://jmblog.github.io/color-themes-for-google-code-prettify/themes/tomorrow-night.min.css">
<link type="text/css" rel="stylesheet" href="styles/app.min.css">
<link type="text/css" rel="stylesheet" href="styles/iframe.css">
<link type="text/css" rel="stylesheet" href="">
<link type="text/css" rel="stylesheet" href="jsdoc.css">
<script async defer src="https://buttons.github.io/buttons.js"></script>
@ -42,6 +42,10 @@
</a>
<div class="logo">
<a href="index.html">
<h1 class="navbar-item">Ittai Documentation</h1>
</a>
</div>
<div class="menu">
@ -54,6 +58,15 @@
API Documentation
</a>
<a
class="link user-link "
href="https://github.com/Kyza/ittai"
>
GitHub
</a>
</div>
@ -66,9 +79,13 @@
id="sidebarNav"
>
<div class="search-wrapper">
<input id="search" type="text" placeholder="Search docs..." class="input">
</div>
<nav>
<h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Classes</h3><ul><li><a href="components.html">components</a></li></ul><h3>Global</h3><ul><li><a href="global.html#FontAwesome">FontAwesome</a></li><li><a href="global.html#getClientMod">getClientMod</a></li><li><a href="global.html#Plugin">Plugin</a></li></ul></div>
<h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Modules</h3><ul><li><a href="module-components.html">components</a></li><li><a href="module-entities.html">entities</a></li><li><a href="module-libraries.html">libraries</a></li><li><a href="module-utils.html">utils</a></li><li><a href="module-utils_logger.html">utils/logger</a></li><li><a href="module-utils_patcher.html">utils/patcher</a></li><li><a href="module-webpack.html">webpack</a></li><li><a href="module-webpack_classes.html">webpack/classes</a></li><li><a href="module-webpack_components.html">webpack/components</a></li><li><a href="module-webpack_modules.html">webpack/modules</a></li></ul></div>
</nav>
</div>
@ -85,15 +102,11 @@
<section>
<article>
<pre class="prettyprint source linenums"><code>import { FontAwesome as fa } from "./FontAwesome";
/**
* @classdesc Useful React components.
<pre class="prettyprint source linenums"><code>/**
* @module components
*/
class components {
static FontAwesome = fa;
}
export default components;
export const FontAwesome = import("./FontAwesome");
</code></pre>
</article>
</section>
@ -103,16 +116,6 @@ export default components;
</div>
<footer class="footer">
<div class="content has-text-centered">
<p>Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a></p>
<p class="sidebar-created-by">
<a href="https://github.com/SoftwareBrothers/better-docs" target="_blank">BetterDocs theme</a> provided with <i class="fas fa-heart"></i> by
<a href="http://softwarebrothers.co" target="_blank">SoftwareBrothers - JavaScript Development Agency</a>
</p>
</div>
</footer>
</div>
<div id="side-nav" class="side-nav">
</div>
@ -121,5 +124,7 @@ export default components;
<script>PR.prettyPrint();</script>
<script src="scripts/linenumber.js"> </script>
<script src="scripts/search.js"> </script>
</body>
</html>

2
docs/entities_index.js.html
View File

@ -85,7 +85,7 @@
<nav>
<h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Modules</h3><ul><li><a href="module-entities.html">entities</a></li><li><a href="module-libraries.html">libraries</a></li><li><a href="module-reactComponents.html">reactComponents</a></li><li><a href="module-utils.html">utils</a></li><li><a href="module-webpack.html">webpack</a></li></ul></div><div class="category"><h2>reactComponents</h2><h3>Components</h3><ul><li><a href="FontAwesome.html">FontAwesome</a></li></ul></div><div class="category"><h2>utils</h2><h3>Modules</h3><ul><li><a href="module-logger.html">logger</a></li><li><a href="module-patcher.html">patcher</a></li></ul></div><div class="category"><h2>utils.patcher.patch</h2><h3>Namespaces</h3><ul><li><a href="module-patcher.patch-patchData.html">patchData</a></li></ul></div><div class="category"><h2>webpack</h2><h3>Modules</h3><ul><li><a href="module-classes.html">classes</a></li><li><a href="module-components.html">components</a></li><li><a href="module-modules.html">modules</a></li></ul></div>
<h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Modules</h3><ul><li><a href="module-components.html">components</a></li><li><a href="module-entities.html">entities</a></li><li><a href="module-libraries.html">libraries</a></li><li><a href="module-utils.html">utils</a></li><li><a href="module-utils_logger.html">utils/logger</a></li><li><a href="module-utils_patcher.html">utils/patcher</a></li><li><a href="module-webpack.html">webpack</a></li><li><a href="module-webpack_classes.html">webpack/classes</a></li><li><a href="module-webpack_components.html">webpack/components</a></li><li><a href="module-webpack_modules.html">webpack/modules</a></li></ul></div>
</nav>
</div>

2
docs/index.html
View File

@ -83,7 +83,7 @@
<nav>
<h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Modules</h3><ul><li><a href="module-entities.html">entities</a></li><li><a href="module-libraries.html">libraries</a></li><li><a href="module-reactComponents.html">reactComponents</a></li><li><a href="module-utils.html">utils</a></li><li><a href="module-webpack.html">webpack</a></li></ul></div><div class="category"><h2>reactComponents</h2><h3>Components</h3><ul><li><a href="FontAwesome.html">FontAwesome</a></li></ul></div><div class="category"><h2>utils</h2><h3>Modules</h3><ul><li><a href="module-logger.html">logger</a></li><li><a href="module-patcher.html">patcher</a></li></ul></div><div class="category"><h2>utils.patcher.patch</h2><h3>Namespaces</h3><ul><li><a href="module-patcher.patch-patchData.html">patchData</a></li></ul></div><div class="category"><h2>webpack</h2><h3>Modules</h3><ul><li><a href="module-classes.html">classes</a></li><li><a href="module-components.html">components</a></li><li><a href="module-modules.html">modules</a></li></ul></div>
<h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Modules</h3><ul><li><a href="module-components.html">components</a></li><li><a href="module-entities.html">entities</a></li><li><a href="module-libraries.html">libraries</a></li><li><a href="module-utils.html">utils</a></li><li><a href="module-utils_logger.html">utils/logger</a></li><li><a href="module-utils_patcher.html">utils/patcher</a></li><li><a href="module-webpack.html">webpack</a></li><li><a href="module-webpack_classes.html">webpack/classes</a></li><li><a href="module-webpack_components.html">webpack/components</a></li><li><a href="module-webpack_modules.html">webpack/modules</a></li></ul></div>
</nav>
</div>

2
docs/libraries_index.js.html
View File

@ -85,7 +85,7 @@
<nav>
<h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Modules</h3><ul><li><a href="module-entities.html">entities</a></li><li><a href="module-libraries.html">libraries</a></li><li><a href="module-reactComponents.html">reactComponents</a></li><li><a href="module-utils.html">utils</a></li><li><a href="module-webpack.html">webpack</a></li></ul></div><div class="category"><h2>reactComponents</h2><h3>Components</h3><ul><li><a href="FontAwesome.html">FontAwesome</a></li></ul></div><div class="category"><h2>utils</h2><h3>Modules</h3><ul><li><a href="module-logger.html">logger</a></li><li><a href="module-patcher.html">patcher</a></li></ul></div><div class="category"><h2>utils.patcher.patch</h2><h3>Namespaces</h3><ul><li><a href="module-patcher.patch-patchData.html">patchData</a></li></ul></div><div class="category"><h2>webpack</h2><h3>Modules</h3><ul><li><a href="module-classes.html">classes</a></li><li><a href="module-components.html">components</a></li><li><a href="module-modules.html">modules</a></li></ul></div>
<h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Modules</h3><ul><li><a href="module-components.html">components</a></li><li><a href="module-entities.html">entities</a></li><li><a href="module-libraries.html">libraries</a></li><li><a href="module-utils.html">utils</a></li><li><a href="module-utils_logger.html">utils/logger</a></li><li><a href="module-utils_patcher.html">utils/patcher</a></li><li><a href="module-webpack.html">webpack</a></li><li><a href="module-webpack_classes.html">webpack/classes</a></li><li><a href="module-webpack_components.html">webpack/components</a></li><li><a href="module-webpack_modules.html">webpack/modules</a></li></ul></div>
</nav>
</div>

2
docs/module-classes.html
View File

@ -83,7 +83,7 @@
<nav>
<h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Modules</h3><ul><li><a href="module-entities.html">entities</a></li><li><a href="module-libraries.html">libraries</a></li><li><a href="module-reactComponents.html">reactComponents</a></li><li><a href="module-utils.html">utils</a></li><li><a href="module-webpack.html">webpack</a></li></ul></div><div class="category"><h2>reactComponents</h2><h3>Components</h3><ul><li><a href="FontAwesome.html">FontAwesome</a></li></ul></div><div class="category"><h2>utils</h2><h3>Modules</h3><ul><li><a href="module-logger.html">logger</a></li><li><a href="module-patcher.html">patcher</a></li></ul></div><div class="category"><h2>utils.patcher.patch</h2><h3>Namespaces</h3><ul><li><a href="module-patcher.patch-patchData.html">patchData</a></li></ul></div><div class="category"><h2>webpack</h2><h3>Modules</h3><ul><li><a href="module-classes.html">classes</a></li><li><a href="module-components.html">components</a></li><li><a href="module-modules.html">modules</a></li></ul></div>
<h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Modules</h3><ul><li><a href="module-entities.html">entities</a></li><li><a href="module-libraries.html">libraries</a></li><li><a href="module-reactComponents.html">reactComponents</a></li><li><a href="module-utils.html">utils</a></li><li><a href="module-utils_logger.html">utils/logger</a></li><li><a href="module-utils_patcher.html">utils/patcher</a></li><li><a href="module-webpack.html">webpack</a></li></ul></div><div class="category"><h2>ReactComponents</h2><h3>Components</h3><ul><li><a href="FontAwesome.html">FontAwesome</a></li></ul></div><div class="category"><h2>webpack</h2><h3>Modules</h3><ul><li><a href="module-classes.html">classes</a></li><li><a href="module-components.html">components</a></li><li><a href="module-modules.html">modules</a></li></ul></div>
</nav>
</div>

372
docs/module-components.html
View File

@ -83,7 +83,7 @@
<nav>
<h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Modules</h3><ul><li><a href="module-entities.html">entities</a></li><li><a href="module-libraries.html">libraries</a></li><li><a href="module-reactComponents.html">reactComponents</a></li><li><a href="module-utils.html">utils</a></li><li><a href="module-webpack.html">webpack</a></li></ul></div><div class="category"><h2>reactComponents</h2><h3>Components</h3><ul><li><a href="FontAwesome.html">FontAwesome</a></li></ul></div><div class="category"><h2>utils</h2><h3>Modules</h3><ul><li><a href="module-logger.html">logger</a></li><li><a href="module-patcher.html">patcher</a></li></ul></div><div class="category"><h2>utils.patcher.patch</h2><h3>Namespaces</h3><ul><li><a href="module-patcher.patch-patchData.html">patchData</a></li></ul></div><div class="category"><h2>webpack</h2><h3>Modules</h3><ul><li><a href="module-classes.html">classes</a></li><li><a href="module-components.html">components</a></li><li><a href="module-modules.html">modules</a></li></ul></div>
<h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Modules</h3><ul><li><a href="module-components.html">components</a></li><li><a href="module-entities.html">entities</a></li><li><a href="module-libraries.html">libraries</a></li><li><a href="module-utils.html">utils</a></li><li><a href="module-utils_logger.html">utils/logger</a></li><li><a href="module-utils_patcher.html">utils/patcher</a></li><li><a href="module-webpack.html">webpack</a></li><li><a href="module-webpack_classes.html">webpack/classes</a></li><li><a href="module-webpack_components.html">webpack/components</a></li><li><a href="module-webpack_modules.html">webpack/modules</a></li></ul></div>
</nav>
</div>
@ -128,103 +128,6 @@
<div class='vertical-section'>
<h1>Members</h1>
<div class="members">
<div class="member">
<span class="method-parameter is-pulled-right">
<label>Type:</label>
<span class="param-type">Proxy</span>
</span>
<h4 class="name" id=".all">
<a class="href-link" href="#.all">#</a>
<span class='tag'>static</span>
<span class='tag'>constant</span>
<span class="code-name">
all
</span>
</h4>
<div class="description">
<p>A <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy/">Proxy</a> of all React components in Discord's Webpack modules.</p>
</div>
<dl class="details">
<p class="tag-source">
<a href="webpack_components.js.html" class="button">View Source</a>
<span>
<a href="webpack_components.js.html">webpack/components.js</a>, <a href="webpack_components.js.html#line73">line 73</a>
</span>
</p>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>const {MiniPopover, Text} = ittai.webpack.components.all;</code></pre>
</div>
</div>
</div>
<div class='vertical-section'>
@ -235,8 +138,8 @@
<h4 class="name" id=".getAllComponentsFromModule">
<a class="href-link" href="#.getAllComponentsFromModule">#</a>
<h4 class="name" id=".FontAwesome">
<a class="href-link" href="#.FontAwesome">#</a>
<span class='tag'>static</span>
@ -244,7 +147,7 @@
<span class="code-name">
getAllComponentsFromModule<span class="signature">(module)</span><span class="type-signature"></span>
FontAwesome<span class="signature">(props)</span><span class="type-signature"></span>
</span>
</h4>
@ -253,7 +156,7 @@
<div class="description">
<p>Extracts all of the React components from a Webpack module.</p>
<p>Render any <a href="https://fontawesome.com/">FontAwesome</a> icon. This includes FontAwesome Pro icons.</p>
</div>
@ -278,8 +181,12 @@
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
@ -291,25 +198,153 @@
<tr class="deep-level-0">
<td class="name"><code>module</code></td>
<td class="name"><code>props</code></td>
<td class="type">
<span class="param-type">Object</span>
<span class="param-type">object</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The module to search.</p></td>
<td class="default">
</td>
<td class="description last"><p>React properties.</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>type</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
"solid"
</td>
<td class="description last"><p>The FontAwesome icon type. <code>solid</code>, <code>regular</code>, <code>light</code>, <code>duotone</code>, <code>brand</code>.</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>size</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>The size of the icon in pixels. Don't include <code>px</code>.</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>className</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
""
</td>
<td class="description last"><p><a href="https://fontawesome.com/how-to-use/on-the-web/styling/duotone-icons">For extra class features that aren't directly supported.</a></p></td>
</tr>
</tbody>
@ -353,9 +388,9 @@
<p class="tag-source">
<a href="webpack_components.js.html" class="button">View Source</a>
<a href="components_FontAwesome.js.html" class="button">View Source</a>
<span>
<a href="webpack_components.js.html">webpack/components.js</a>, <a href="webpack_components.js.html#line15">line 15</a>
<a href="components_FontAwesome.js.html">components/FontAwesome.js</a>, <a href="components_FontAwesome.js.html#line14">line 14</a>
</span>
</p>
@ -381,132 +416,13 @@
</div>
<div class="member">
<h4 class="name" id=".updateComponents">
<a class="href-link" href="#.updateComponents">#</a>
<span class='tag'>static</span>
<span class="code-name">
updateComponents<span class="signature">()</span><span class="type-signature"> &rarr; {Object}</span>
</span>
</h4>
<h5>Example</h5>
<div class="description">
<p>Updates the React component cache.</p>
</div>
<pre class="prettyprint"><code>return ( &lt;FontAwesome type="brand" name="discord" size="22" /> );</code></pre>
<dl class="details">
<p class="tag-source">
<a href="webpack_components.js.html" class="button">View Source</a>
<span>
<a href="webpack_components.js.html">webpack/components.js</a>, <a href="webpack_components.js.html#line48">line 48</a>
</span>
</p>
</dl>
<div class='columns method-parameter'>
<div class="column is-2"><label>Returns:</label></div>
<div class="column is-10">
<div class="columns">
<div class='param-desc column is-7'><p>The React component cache.</p></div>
<div class='column is-5 has-text-left'>
<label>Type: </label>
<span class="param-type">Object</span>
</div>
</div>
</div>
</div>
</div>
</div>

2
docs/module-entities.html
View File

@ -83,7 +83,7 @@
<nav>
<h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Modules</h3><ul><li><a href="module-entities.html">entities</a></li><li><a href="module-libraries.html">libraries</a></li><li><a href="module-reactComponents.html">reactComponents</a></li><li><a href="module-utils.html">utils</a></li><li><a href="module-webpack.html">webpack</a></li></ul></div><div class="category"><h2>reactComponents</h2><h3>Components</h3><ul><li><a href="FontAwesome.html">FontAwesome</a></li></ul></div><div class="category"><h2>utils</h2><h3>Modules</h3><ul><li><a href="module-logger.html">logger</a></li><li><a href="module-patcher.html">patcher</a></li></ul></div><div class="category"><h2>utils.patcher.patch</h2><h3>Namespaces</h3><ul><li><a href="module-patcher.patch-patchData.html">patchData</a></li></ul></div><div class="category"><h2>webpack</h2><h3>Modules</h3><ul><li><a href="module-classes.html">classes</a></li><li><a href="module-components.html">components</a></li><li><a href="module-modules.html">modules</a></li></ul></div>
<h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Modules</h3><ul><li><a href="module-components.html">components</a></li><li><a href="module-entities.html">entities</a></li><li><a href="module-libraries.html">libraries</a></li><li><a href="module-utils.html">utils</a></li><li><a href="module-utils_logger.html">utils/logger</a></li><li><a href="module-utils_patcher.html">utils/patcher</a></li><li><a href="module-webpack.html">webpack</a></li><li><a href="module-webpack_classes.html">webpack/classes</a></li><li><a href="module-webpack_components.html">webpack/components</a></li><li><a href="module-webpack_modules.html">webpack/modules</a></li></ul></div>
</nav>
</div>

2
docs/module-libraries.html
View File

@ -83,7 +83,7 @@
<nav>
<h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Modules</h3><ul><li><a href="module-entities.html">entities</a></li><li><a href="module-libraries.html">libraries</a></li><li><a href="module-reactComponents.html">reactComponents</a></li><li><a href="module-utils.html">utils</a></li><li><a href="module-webpack.html">webpack</a></li></ul></div><div class="category"><h2>reactComponents</h2><h3>Components</h3><ul><li><a href="FontAwesome.html">FontAwesome</a></li></ul></div><div class="category"><h2>utils</h2><h3>Modules</h3><ul><li><a href="module-logger.html">logger</a></li><li><a href="module-patcher.html">patcher</a></li></ul></div><div class="category"><h2>utils.patcher.patch</h2><h3>Namespaces</h3><ul><li><a href="module-patcher.patch-patchData.html">patchData</a></li></ul></div><div class="category"><h2>webpack</h2><h3>Modules</h3><ul><li><a href="module-classes.html">classes</a></li><li><a href="module-components.html">components</a></li><li><a href="module-modules.html">modules</a></li></ul></div>
<h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Modules</h3><ul><li><a href="module-components.html">components</a></li><li><a href="module-entities.html">entities</a></li><li><a href="module-libraries.html">libraries</a></li><li><a href="module-utils.html">utils</a></li><li><a href="module-utils_logger.html">utils/logger</a></li><li><a href="module-utils_patcher.html">utils/patcher</a></li><li><a href="module-webpack.html">webpack</a></li><li><a href="module-webpack_classes.html">webpack/classes</a></li><li><a href="module-webpack_components.html">webpack/components</a></li><li><a href="module-webpack_modules.html">webpack/modules</a></li></ul></div>
</nav>
</div>

2
docs/module-logger.html
View File

@ -83,7 +83,7 @@
<nav>
<h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Modules</h3><ul><li><a href="module-entities.html">entities</a></li><li><a href="module-libraries.html">libraries</a></li><li><a href="module-reactComponents.html">reactComponents</a></li><li><a href="module-utils.html">utils</a></li><li><a href="module-webpack.html">webpack</a></li></ul></div><div class="category"><h2>reactComponents</h2><h3>Components</h3><ul><li><a href="FontAwesome.html">FontAwesome</a></li></ul></div><div class="category"><h2>utils</h2><h3>Modules</h3><ul><li><a href="module-logger.html">logger</a></li><li><a href="module-patcher.html">patcher</a></li></ul></div><div class="category"><h2>utils.patcher.patch</h2><h3>Namespaces</h3><ul><li><a href="module-patcher.patch-patchData.html">patchData</a></li></ul></div><div class="category"><h2>webpack</h2><h3>Modules</h3><ul><li><a href="module-classes.html">classes</a></li><li><a href="module-components.html">components</a></li><li><a href="module-modules.html">modules</a></li></ul></div>
<h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Modules</h3><ul><li><a href="module-entities.html">entities</a></li><li><a href="module-libraries.html">libraries</a></li><li><a href="module-reactComponents.html">reactComponents</a></li><li><a href="module-utils.html">utils</a></li><li><a href="module-utils_patcher.html">utils/patcher</a></li><li><a href="module-webpack.html">webpack</a></li></ul></div><div class="category"><h2>reactComponents</h2><h3>Components</h3><ul><li><a href="FontAwesome.html">FontAwesome</a></li></ul></div><div class="category"><h2>utils</h2><h3>Modules</h3><ul><li><a href="module-logger.html">logger</a></li></ul></div><div class="category"><h2>utils.patcher.patch</h2><h3>Namespaces</h3><ul><li><a href="module-utils_patcher.patchData.html">patchData</a></li></ul></div><div class="category"><h2>webpack</h2><h3>Modules</h3><ul><li><a href="module-classes.html">classes</a></li><li><a href="module-components.html">components</a></li><li><a href="module-modules.html">modules</a></li></ul></div>
</nav>
</div>

2
docs/module-modules.html
View File

@ -83,7 +83,7 @@
<nav>
<h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Modules</h3><ul><li><a href="module-entities.html">entities</a></li><li><a href="module-libraries.html">libraries</a></li><li><a href="module-reactComponents.html">reactComponents</a></li><li><a href="module-utils.html">utils</a></li><li><a href="module-webpack.html">webpack</a></li></ul></div><div class="category"><h2>reactComponents</h2><h3>Components</h3><ul><li><a href="FontAwesome.html">FontAwesome</a></li></ul></div><div class="category"><h2>utils</h2><h3>Modules</h3><ul><li><a href="module-logger.html">logger</a></li><li><a href="module-patcher.html">patcher</a></li></ul></div><div class="category"><h2>utils.patcher.patch</h2><h3>Namespaces</h3><ul><li><a href="module-patcher.patch-patchData.html">patchData</a></li></ul></div><div class="category"><h2>webpack</h2><h3>Modules</h3><ul><li><a href="module-classes.html">classes</a></li><li><a href="module-components.html">components</a></li><li><a href="module-modules.html">modules</a></li></ul></div>
<h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Modules</h3><ul><li><a href="module-entities.html">entities</a></li><li><a href="module-libraries.html">libraries</a></li><li><a href="module-reactComponents.html">reactComponents</a></li><li><a href="module-utils.html">utils</a></li><li><a href="module-utils_logger.html">utils/logger</a></li><li><a href="module-utils_patcher.html">utils/patcher</a></li><li><a href="module-webpack.html">webpack</a></li></ul></div><div class="category"><h2>ReactComponents</h2><h3>Components</h3><ul><li><a href="FontAwesome.html">FontAwesome</a></li></ul></div><div class="category"><h2>webpack</h2><h3>Modules</h3><ul><li><a href="module-classes.html">classes</a></li><li><a href="module-components.html">components</a></li><li><a href="module-modules.html">modules</a></li></ul></div>
</nav>
</div>

325
docs/module-patcher.patchData.html Normal file
View File

@ -0,0 +1,325 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Ittai patchData</title>
<script src="https://cdn.jsdelivr.net/gh/google/code-prettify@master/loader/run_prettify.js"></script>
<script src="https://unpkg.com/@babel/standalone/babel.min.js"></script>
<script src="./build/entry.js"></script>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link href="https://fonts.googleapis.com/css?family=Roboto:100,400,700|Inconsolata,700" rel="stylesheet">
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-UHRtZLI+pbxtHCWp1t77Bi1L4ZtiqrqD80Kn4Z8NTSRyMA2Fd33n5dQ8lWUE00s/" crossorigin="anonymous">
<link type="text/css" rel="stylesheet" href="https://jmblog.github.io/color-themes-for-google-code-prettify/themes/tomorrow-night.min.css">
<link type="text/css" rel="stylesheet" href="styles/app.min.css">
<link type="text/css" rel="stylesheet" href="styles/iframe.css">
<link type="text/css" rel="stylesheet" href="jsdoc.css">
<script async defer src="https://buttons.github.io/buttons.js"></script>
</head>
<body class="layout small-header">
<div id="stickyNavbarOverlay"></div>
<div class="top-nav">
<div class="inner">
<a id="hamburger" role="button" class="navbar-burger" aria-label="menu" aria-expanded="false">
<span aria-hidden="true"></span>
<span aria-hidden="true"></span>
<span aria-hidden="true"></span>
</a>
<div class="logo">
<a href="index.html">
<h1 class="navbar-item">Ittai Documentation</h1>
</a>
</div>
<div class="menu">
<div class="navigation">
<a
href="index.html"
class="link"
>
API Documentation
</a>
<a
class="link user-link "
href="https://github.com/Kyza/ittai"
>
GitHub
</a>
</div>
</div>
</div>
</div>
<div id="main">
<div
class="sidebar "
id="sidebarNav"
>
<div class="search-wrapper">
<input id="search" type="text" placeholder="Search docs..." class="input">
</div>
<nav>
<h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Modules</h3><ul><li><a href="module-entities.html">entities</a></li><li><a href="module-libraries.html">libraries</a></li><li><a href="module-reactComponents.html">reactComponents</a></li><li><a href="module-utils.html">utils</a></li><li><a href="module-webpack.html">webpack</a></li></ul></div><div class="category"><h2>reactComponents</h2><h3>Components</h3><ul><li><a href="FontAwesome.html">FontAwesome</a></li></ul></div><div class="category"><h2>utils</h2><h3>Modules</h3><ul><li><a href="module-logger.html">logger</a></li><li><a href="module-patcher.html">patcher</a></li></ul></div><div class="category"><h2>utils.patcher.patch</h2><h3>Namespaces</h3><ul><li><a href="module-patcher.patchData.html">patchData</a></li></ul></div><div class="category"><h2>webpack</h2><h3>Modules</h3><ul><li><a href="module-classes.html">classes</a></li><li><a href="module-components.html">components</a></li><li><a href="module-modules.html">modules</a></li></ul></div>
</nav>
</div>
<div class="core" id="main-content-wrapper">
<div class="content">
<header class="page-title">
<p>Namespace</p>
<h1>patchData</h1>
</header>
<section>
<header>
<h2>
<span class="ancestors"><a href="module-patcher.html">patcher</a>.</span>patchData</h2>
</header>
<article>
<div class="container-overview">