@dboio/launchpad-icons 4.0.1

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2022 manolab, LLC. (dbo.io)
+Developed by Christian Fillies
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,150 @@
+# launchpad icons
+Convert Sketch icons using fontello. Used Documentation from [dboio/icons](https://github.com/dboio/icons/blob/main/README.md) for Fontello use.
+Fontello project to combine svgs and fonts into a single font for icons. 
+[Fontello](https://fontello.com/) is an online app that can generate fonts. 
+
+# documentation and builder
+<a href="https://dboio.github.io/launchpad-icons/" target="_blank">Documentation</a>
+
+<a href="https://dboio.github.io/launchpad-icons/#builder" target="_blank">Builder</a>
+
+# install (consumers)
+Published to npm as **[`@dboio/launchpad-icons`](https://www.npmjs.com/package/@dboio/launchpad-icons)**. Only the compiled CSS and fonts ship — no source, SVGs, or build tooling.
+
+### npm
+```sh
+npm i @dboio/launchpad-icons
+```
+Import the stylesheet (relative font paths resolve automatically):
+```js
+import '@dboio/launchpad-icons'        // launchpad-icons.css
+import '@dboio/launchpad-icons/min'    // launchpad-icons.min.css
+```
+Or link it directly:
+```html
+<link rel="stylesheet" href="node_modules/@dboio/launchpad-icons/dist/assets/css/launchpad-icons.min.css">
+```
+
+### CDN (jsDelivr)
+No install — pin a version (or use `@latest`):
+```html
+<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@dboio/launchpad-icons@latest/dist/assets/css/launchpad-icons.min.css">
+```
+
+Use icons with the `li-` prefix, e.g. `<i class="li-dbo"></i>`. See the [documentation](https://dboio.github.io/launchpad-icons/) for the full glyph list and modifiers.
+
+> **Releasing:** publishing is automated — push a `v*.*.*` tag and `.github/workflows/release.yml` publishes to npm with provenance. A guard test (`npm test`) asserts the tarball never includes source or private files.
+
+# setup local environment
+The Following are required
+* [node.js](https://nodejs.org/en/download/) 
+* [NPM](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
+* [Homebrew](https://brew.sh/)
+* [jq](https://macappstore.org/jq/) (when not automatically installed with npm install)
+
+Run the following commands
+1. `cd` into your local bin of the clone
+2. `git clone https://github.com/dboio/icons`
+3. `npm install fontello-cli -g`
+4. `npm install` ~ for dependencies and additional third party fonts download
+
+## Open Font on Fontello to Edit
+Open the current config online
+* `npm run regular:open` for [./font-weight/regular/]
+  * Executes `fontello-cli --config ./font-weight/regular/config.json open`
+* `npm run lighter:open` for [./font-weight/lighter/]
+  * Executes `fontello-cli --config ./font-weight/lighter/config.json open`
+* **WARNING!** The `fontello-cli` has an issue where the session is not cleared. So when switching to another font-weight you need to clear the browser cache and restart the browser. Make sure the `:open` opens the correct font-weight, else the session persists. If the issue still persists, use the "Import" option from the wrench menu on fontello.com, and pick the correct `config.json` manually.
+
+
+Download and unpack the font as demo bin
+* `fontello-cli --config config.json install`
+
+## Install Fonts
+Download and install into project bins
+* `npm run regular:install`
+  * Executes `fontello-cli --config ./font-weight/regular/config.json --css ./src/css/ --font ./dist/assets/fonts/ install && npm run cleanup`
+* `npm run lighter:install`
+  * Executes `fontello-cli --config ./font-weight/lighter/config.json --css ./src/css/ --font ./dist/assets/fonts/ install && npm run cleanup`
+* **NOTE!** The font face `regular` is the basis for the character map. So for the distribution the only file that is required in the `src/css` directory is `launchpad-icons-regular-codes.css`.
+* **NOTE!** Warning above!
+
+## Build [SHORTHAND]
+Allows running thru a stack of scripts that updates a font-weight based on the current browser session as well as deploys into the documentation directory.
+* `npm run regular:build`
+* `npm run lighter:build`
+* **NOTE!** Warning above!
+
+## Sorting Icon Lists by CSS Name
+Sort icons for json glyphs
+* `npm run sort`
+* or the manual way
+  1. copy glyph array from json
+  2. paste into console and run
+  3. ```javascript
+      [].sort((a,b) => (a.css > b.css) ? 1 : ((b.css > a.css) ? -1 : 0));
+      ```
+  4. copy returned object and paste back into json
+
+
+## Sort icons by alphabet in demo.html page
+* ```javascript
+  for (let r of Array.from(document.querySelectorAll('.span3')).sort((a,b) => (a.querySelector('.i-name').innerText > b.querySelector('.i-name').innerText) ? 1 : ((b.querySelector('.i-name').innerText > a.querySelector('.i-name').innerText) ? -1 : 0))) { document.getElementById('icons').appendChild(r) };
+    ```
+
+### Sketch Icons
+* [Convert to Compound Paths](https://youtu.be/0ZZSafmcBYE)
+* [Add to Fontello](https://youtu.be/eCdVHFruCp4)
+
+## Compile and update docs
+Compiles the SASS to CSS, minifies, stamps the version banner, and copies the result into `docs/` for the documentation site.
+* `npm run prepare`
+  * Executes the following:
+  ```
+  sass src/sass/launchpad-icons.sass dist/assets/css/launchpad-icons.css
+  csso dist/assets/css/launchpad-icons.css --output dist/assets/css/launchpad-icons.min.css
+  node scripts/banner.mjs            # stamp the version banner — see "Versioning"
+  cp dist/assets/css/launchpad-icons.min.css docs/assets/css/launchpad-icons.css
+  cp -R dist/assets/fonts docs/assets
+  cp font-weight/regular/config.json docs/assets/js/config.json
+  npm run cleanup
+  ```
+
+## Versioning
+The version lives in **one place**: `package.json`. The CSS banner is generated at build time by `scripts/banner.mjs` — never hand-type a version into the SASS source (it drifts).
+* The banner is stamped onto `dist/assets/css/launchpad-icons.css` and `.min.css` *after* `sass` + `csso` run, so the minifier can't strip it.
+* Version source: a GitHub release tag (`GITHUB_REF_NAME`, e.g. `v4.1.0`) wins when present — so a tagged release publishes under exactly that version — otherwise `package.json`'s `version`. The date is always the build date.
+* To cut a release: `npm version <patch|minor|major>` then `git push --follow-tags`. The `v*.*.*` tag triggers the npm publish workflow.
+
+## Automated builds (GitHub Actions)
+`.github/workflows/build.yml` keeps the published CSS and the docs site in sync without a manual local build.
+* On every push to `main` touching `src/**`, `font-weight/regular/config.json`, or `package.json`, it runs `npm run prepare` and commits the rebuilt `dist/` + `docs/` back to `main` (tagged `[skip ci]`, so it never retriggers itself).
+* Trigger a rebuild manually from the **Actions** tab, or with `npm run trigger-build` (`gh workflow run build.yml`).
+* `.github/workflows/release.yml` publishes to npm when a `v*.*.*` tag is pushed.
+
+## Cleanup
+Cleanup command removes unwanted files that are not needed for the compilation of files. This is also included in the `prepare` script.
+* `npm run cleanup`
+
+## Deploy to consuming projects
+Copies the compiled CSS and the WOFF2 fonts (both weights) into the sibling projects, if they're checked out in parallel on your hard drive. Each `copy-to-*` is a plain filesystem copy; the `deploy-to-*` wrappers run `npm run prepare` first so you always ship a fresh build.
+
+* **[LaunchpadOS](https://github.com/dboio/launchpad)** — `npm run copy-to-launchpad` (or `deploy-to-launchpad`)
+  * Copies `launchpad-icons.css`, `.min.css`, and both `.woff2` into `../launchpad/media/launchpad/app/assets/`.
+* **Operator** — `npm run copy-to-operator` (or `deploy-to-operator`)
+  * Copies the CSS (plus `_media` variants) and both `.woff2` into `operator/lib/bins/app/assets/`.
+* **dboio-web** — `npm run copy-to-dboio-web` (or `deploy-to-dboio-web`)
+  * Copies `launchpad-icons.min.css` and both `.woff2` into `dboio-web/lib/bins/web/assets/`. These are DBO-tracked assets — run `dbo push` from the dboio-web project to publish them to the server.
+
+
+## SASS Variables
+* `$selected-support`: Default is `true` and sets all icons that have a `-solid` rendition as well, to **solid** when `.selected, *:active, *:focus` is met either on a parent element or the icon itself, so `<i class="li-alert selected"></i>` would be the same as `<i class="li-alert-solid"></i>`. In addition this will also trigger the selected/checked state of the selectable icons: `li-off`, `li-checkbox` and `li-radiobutton`.
+* `$legacy-support`: Default is `true` and supports older classNaming convention:
+  * `li-clear-disc` is same as `li-clear-solid`
+* `$base-unit`: Fallback value for when `--os-unit` is not found. Defaults to `3rem` (about 48px).
+* `$font-name`: Defaults to `'launchpad-icons'`.
+* `$font-path`: Defaults to `'../fonts'`. Sets the path where the font files reside.
+* `$class-prefix`: Prefix for environment classes, such as `.os-modal`. Defaults to `'os-'`.
+* `$rounded-box-class`: Default to `.li-rounded`, which will underlay the icon with a solid rounded box and scale down the graphic to 60%, while also inverting the icon color on top of the rounded box color. When SASS variable `$selected-support` is `true`, then this className is `.li-box`.
+* `$circular-clipping-class`: Default to `.li-ellipse`, will clip (mask) the icon in a circular shape. If you apply a `background-color`, the icon `color` is inverted based on the `background-color` you applied. When SASS variable `$selected-support` is `true`, then this className is `.li-rounded`.
+