[
{
"path": ".github/CODEOWNERS",
"content": "# https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners\n\n/.github/** @ritterim/GitGuardians\n"
},
{
"path": ".github/workflows/pr-build.yml",
"content": "name: PR Build\n\npermissions:\n contents: read\n packages: read\n\non:\n\n # https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request\n # By default, a workflow only runs when a pull_request event's activity type is opened, synchronize, or reopened.\n pull_request:\n types: [ opened, synchronize, reopened, labeled, unlabeled ]\n branches:\n - main\n\njobs:\n\n pr-build:\n uses: ritterim/public-github-actions/.github/workflows/npm-packages-pr-build.yml@v1.16.5\n #uses: ./.github/workflows/npm-packages-pr-build.yml\n with:\n always_increment_patch_version: true\n npm_package_name: skellycss\n run_tests: false\n"
},
{
"path": ".github/workflows/pr-merged.yml",
"content": "name: PR Merged\n\npermissions:\n contents: read\n id-token: write\n packages: read\n\non:\n\n # https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request\n # By default, a workflow only runs when a pull_request event's activity type is opened, synchronize, or reopened.\n # We want to run on 'closed' to trigger, but we also have to check if it was merged.\n # That check is: if: github.event.pull_request.merged == true\n pull_request_target:\n types: [ closed ]\n branches:\n - main\n\njobs:\n\n npm-packages-pr-create-tag:\n uses: ritterim/public-github-actions/.github/workflows/npm-packages-pr-create-tag-jfrog.yml@v1.16.5\n #uses: ./.github/workflows/npm-packages-pr-create-tag-jfrog.yml\n if: github.event.pull_request.merged == true\n secrets:\n gh_actions_secret_passing_passphrase: ${{ secrets.ACTIONS_SECRET_PASSING_PASSPHRASE }}\n gh_app_private_key: ${{ secrets.RIMDEV_NPM_RELEASES_APP_PRIVATE_KEY }}\n with:\n always_increment_patch_version: true\n gh_app_id: ${{ vars.RIMDEV_NPM_RELEASES_APP_APPID }}\n jfrog_api_base_url: ${{ vars.JFROG_API_BASE_URL }}\n jfrog_artifactory_repository: \"${{ vars.JFROG_NPM_PACKAGE_REPO_BASENAME }}-draft\"\n jfrog_audit_xray_watch_list: ${{ vars.JFROG_AUDIT_XRAY_WATCH_LIST }}\n jfrog_build_basename: ${{ vars.JFROG_BUILD_BASENAME }}\n jfrog_npm_feed_repo: ${{ vars.JFROG_ARTIFACTORY_VIRTUAL_REPO_NPM }}\n jfrog_npm_package_repo_basename: ${{ vars.JFROG_NPM_PACKAGE_REPO_BASENAME }}\n jfrog_oidc_provider_name: ${{ vars.JFROG_GHA_OIDC_PROVIDER_NAME }}\n npm_package_name: skellycss\n run_tests: false\n"
},
{
"path": ".github/workflows/version-tag-build-master.yml",
"content": "name: Version Tag Build\n\npermissions:\n contents: write\n id-token: write\n packages: write\n\non:\n push:\n # To limit whether this executes on a specific branch, you must adjust the allowed_branches input.\n # Specifying 'branches' here is a logical 'OR', not a logical 'AND'.\n tags:\n - v0.*\n\njobs:\n\n version-tag-build:\n uses: ritterim/public-github-actions/.github/workflows/npm-packages-release-on-tag-jfrog.yml@v1.16.5\n #uses: ./.github/workflows/npm-packages-release-on-tag-jfrog.yml\n secrets:\n npmjs_org_api_key: ${{ secrets.RITTERIM_NPMJS_PUBLISH_TOKEN }}\n with:\n allowed_branches: |\n main\n jfrog_api_base_url: ${{ vars.JFROG_API_BASE_URL }}\n jfrog_artifactory_repository: \"${{ vars.JFROG_NPM_PACKAGE_REPO_BASENAME }}-prod\"\n jfrog_audit_xray_watch_list: ${{ vars.JFROG_AUDIT_XRAY_WATCH_LIST }}\n jfrog_build_basename: ${{ vars.JFROG_BUILD_BASENAME }}\n jfrog_npm_feed_repo: ${{ vars.JFROG_ARTIFACTORY_VIRTUAL_REPO_NPM }}\n jfrog_npm_package_repo_basename: ${{ vars.JFROG_NPM_PACKAGE_REPO_BASENAME }}\n jfrog_oidc_provider_name: ${{ vars.JFROG_GHA_OIDC_PROVIDER_NAME }}\n npm_package_name: skellycss\n run_tests: false\n npmjs_org_access_public: true\n publish_to_npmjs_org: true\n"
},
{
"path": ".gitignore",
"content": "#Distribution\ndist/\n\n# Logs\nlogs\n*.log\nnpm-debug.log*\nyarn-debug.log*\nyarn-error.log*\nlerna-debug.log*\n\n# Diagnostic reports (https://nodejs.org/api/report.html)\nreport.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json\n\n# Runtime data\npids\n*.pid\n*.seed\n*.pid.lock\n\n# Directory for instrumented libs generated by jscoverage/JSCover\nlib-cov\n\n# Coverage directory used by tools like istanbul\ncoverage\n*.lcov\n\n# nyc test coverage\n.nyc_output\n\n# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)\n.grunt\n\n# Bower dependency directory (https://bower.io/)\nbower_components\n\n# node-waf configuration\n.lock-wscript\n\n# Compiled binary addons (https://nodejs.org/api/addons.html)\nbuild/Release\n\n# Dependency directories\nnode_modules/\njspm_packages/\n\n# TypeScript v1 declaration files\ntypings/\n\n# TypeScript cache\n*.tsbuildinfo\n\n# Optional npm cache directory\n.npm\n\n# Optional eslint cache\n.eslintcache\n\n# Microbundle cache\n.rpt2_cache/\n.rts2_cache_cjs/\n.rts2_cache_es/\n.rts2_cache_umd/\n\n# Optional REPL history\n.node_repl_history\n\n# Output of 'npm pack'\n*.tgz\n\n# Yarn Integrity file\n.yarn-integrity\n\n# dotenv environment variables file\n.env\n.env.test\n\n# parcel-bundler cache (https://parceljs.org/)\n.cache\n\n# Next.js build output\n.next\n\n# Nuxt.js build / generate output\n.nuxt\n\n# Gatsby files\n.cache/\n# Comment in the public line in if your project uses Gatsby and *not* Next.js\n# https://nextjs.org/blog/next-9-1#public-directory-support\n# public\n\n# vuepress build output\n.vuepress/dist\n\n# Serverless directories\n.serverless/\n\n# FuseBox cache\n.fusebox/\n\n# DynamoDB Local files\n.dynamodb/\n\n# TernJS port file\n.tern-port\n\n#Other Files\n.DS_store"
},
{
"path": ".sassrc",
"content": "{\n \"includePaths\": [\"node_modules\"]\n}"
},
{
"path": "LICENSE",
"content": "MIT License\n\nCopyright (c) 2020 Ritter Insurance Marketing\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n"
},
{
"path": "README.md",
"content": "
\n \n
\n\n# skellyCSS\nA light-weight CSS framework to quickly implement skeletons into your projects.\n\n\n
Table of Contents
\n\n- [skellyCSS](#skellycss)\n - [Installation](#installation)\n - [npm](#npm)\n - [CSS](#css)\n - [JavaScript](#javascript)\n - [Quick Usage](#quick-usage)\n - [Usage](#usage)\n - [Headers](#headers)\n - [Paragraphs](#paragraphs)\n - [Line Width](#line-width)\n - [Alignment](#alignment)\n - [Images](#images)\n - [Sizes](#sizes)\n - [Shapes](#shapes)\n - [Animation](#animation)\n - [JavaScript Utility](#javascript-utility)\n - [JavaScript Data Attributes](#javascript-data-attributes)\n - [All Data Attributes](#all-data-attributes)\n\n \n\n## Installation\n\n### npm\nTo install via node package manager:\n```shell\nnpm install @ritterim/skellycss\n```\n\n### CSS\nInclude the Skelly css file wherever you add your CSS:\n``` html\n\n```\n\n### JavaScript\nInclude the skelly.js file wherever you add your JavaScript:\n``` html\n\n```\n\n \n\n## Quick Usage\nYou can quickly get started using skellyCSS using the JavaScript utility, like so:\n``` html\n\n\n```\n**See full [JavaScript Utility](#javascript-utility) docs below**\n\n \n\n## Usage\nSkeletons can be quickly added to any project with a few simple lines of code. \n\n### Headers\nApply the `skeleton` class to any type of header and it will automatically adjust to the font-size of the header stylings:\n\n\n\n``` html\n\n\n\n\n\n\n```\n\n \n\n### Paragraphs\nYou can create paragraph skeletons by applying the `skeleton` class to the paragraph tag, then including however many span tags you'd like with the `skeleton__line` class within the paragraph. In order to make the paragraph skeleton look more like a paragraph, the last line is set to 50% width.\n\n\n```html\n
\n
\n \n \n \n \n
\n
\n```\n\n \n\n### Line Width\nYou can adjust the line width by applying a size modifier class:\n| Width | Modifier Class | \n| ------------ | ------------|\n| Small, 25% | `.skeleton--sm` |\n| Medium, 50% | `.skeleton--md` |\n| Large, 75% | `.skeleton--lg` |\n| Full, 100% | `.skeleton--full` |\n\n\n\n``` html\n\n\n\n\n```\n\n \n\n### Alignment\nYou can text align the skeleton using alignment modifier classes:\n\n| Alignment | Modifier Class |\n| ------------ | ------------|\n| Left | `.skeleton--left` |\n| Center | `.skeleton--center` |\n| Right | `.skeleton--right` |\n\n\n\n``` html\n\n
\n \n \n \n \n
\n\n\n
\n \n \n \n \n
\n\n\n
\n \n \n \n \n
\n```\n\n \n\n### Images\nYou can create an image skeleton by using the `.skeleton-image` class. By default this will apply the image skeleton at 100% height and width of the parent container.\n\n#### Sizes\nHere are some default sizes we have included for skeleton images:\n\n| Size | Modifier Class |\n| ------------ | ------------| \n| Small, 50x50 | `.skeleton-image--sm` |\n| Medium, 100x100 | `.skeleton-image--md` |\n| Large, 200x200 | `.skeleton-image--lg` |\n| X-Large, 400x400 | `.skeleton-image--xl` |\n| Full, 100% x 100% | `.skeleton-image--full` |\n\n\n\n``` html\n\n\n\n\n```\n\n \n\n#### Shapes\nYou can also make different image shapes using shape modifier classes:\n\n| Shape | Description | Modifier Class |\n| ------------ |------------ | ------------| \n| Square | Sets the image aspect ratio to 1/1 (default) | `.skeleton-image--square` |\n| Circle | Sets the border radius to 50% | `.skeleton-image--circle` |\n| Landscape Rectangle | Sets the image aspect ratio to 4/3 | `.skeleton-image--landscape` |\n| Portrait Rectangle | Sets the image aspect ratio to 3/4| `.skeleton-image--portrait` |\n| Wide Rectangle | Sets the image aspect ratio to 16/9 | `.skeleton-image--wide` |\n| Tall Rectangle | Sets the image aspect ratio to 9/16 | `.skeleton-image--tall` |\n\n``` html\n\n\n\n\n\n\n```\n\n \n\n### Animation\nTo add animation, add a `span.skeleton--animation` within the `.skeleton__line` elements in headers or paragaphs.\n\n\n\n``` html\n
\n
\n \n \n \n \n \n \n \n \n \n \n \n \n
\n
\n```\n\n \n\n## JavaScript Utility\nThe easiest and our preferred way to add Skeletons is by using the included JavaScript utilities. \n\nOn either a header tag or a paragraph tag, add the `skeleton` class and a `data-lines` attribute with the number of lines you'd like the skeleton to have:\n\n``` html\n\n\n```\n\n \n\nYou can also give the skeleton animation by adding the `data-animation` attribute and setting it to `true`:\n\n``` html\n\n\n```\n\n \n\n### JavaScript Data Attributes\nYou can alter the way skeleton looks by utilizing other data-attributes as well, including opacity and color:\n``` html\n\n\n\n\n\n\n\n```\n\n#### All Data Attributes\n| Attribute | Description | Type |\n| ------------ |------------ | ------------| \n| `data-lines` | Determines how many lines to output | Integer |\n| `data-animation` | Adds animation to the skeleton lines | Boolean |\n| `data-opacity` | Sets the opacity of the skeleton lines (sets opacity between 0 and 1) | Float |\n| `data-color` | Sets the color of the skeleton lines | Color |\n"
},
{
"path": "build.cmd",
"content": "@echo Off\npushd %~dp0\nsetlocal\n\n:Build\ncall npm install\nif %ERRORLEVEL% neq 0 goto BuildFail\n\nif \"%APPVEYOR%\" equ \"True\" (\n echo *** Building Production [%APPVEYOR_REPO_BRANCH%] ***\n call npm run build\n\n) else (\n echo *** Building Default ***\n call npm run serve\n)\n\nif %ERRORLEVEL% neq 0 goto BuildFail\n\ngoto BuildSuccess\n\n:BuildFail\necho.\necho *** BUILD FAILED ***\ngoto End\n\n:BuildSuccess\necho.\necho *** BUILD SUCCEEDED ***\ngoto End\n\n:End\necho.\npopd\nexit /B %ERRORLEVEL%"
},
{
"path": "examples/blog-post.html",
"content": "\n\n\n \n \n Blog Post\n \n\n \n\n\n \n \n \n \n \n \n \n \n \n \n \n\n
\n \n\n\n \n \n\n"
},
{
"path": "main.js",
"content": "import './src/style.scss';\nimport './src/index.js';\n"
},
{
"path": "package/LICENSE",
"content": "MIT License\n\nCopyright (c) 2020 Ritter Insurance Marketing\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n"
},
{
"path": "package/README.md",
"content": "
\n \n
\n\n# skellyCSS\nA light-weight CSS framework to quickly implement skeletons into your projects.\n\n\n
Table of Contents
\n\n- [skellyCSS](#skellycss)\n - [Installation](#installation)\n - [CSS](#css)\n - [JavaScript](#javascript)\n - [Quick Usage](#quick-usage)\n - [Usage](#usage)\n - [Headers](#headers)\n - [Paragraphs](#paragraphs)\n - [Line Width](#line-width)\n - [Alignment](#alignment)\n - [Images](#images)\n - [Sizes](#sizes)\n - [Shapes](#shapes)\n - [Animation](#animation)\n - [JavaScript Utility](#javascript-utility)\n\n \n\n## Installation\n### CSS\nInclude the skelly.css file wherever you add your CSS:\n``` html\n\n```\n\n### JavaScript\nInclude the skelly.js file wherever you add your JavaScript:\n``` html\n\n```\n\n \n\n## Quick Usage\nYou can quickly get started using skellyCSS using the JavaScript utility, like so:\n``` html\n\n
\n```\n**See full [JavaScript Utility](#javascript-utility) docs below**\n\n \n\n## Usage\nSkeletons can be quickly added to any project with a few simple lines of code. \n\n### Headers\nApply the `skeleton` class to any type of header and it will automatically adjust to the font-size of the header stylings:\n\n\n\n``` html\n
\n\n\n\n\n\n```\n\n \n\n### Paragraphs\nYou can create paragraph skeletons by applying the `skeleton` class to the paragraph tag, then including however many span tags you'd like with the `skeleton__line` class within the paragraph. In order to make the paragraph skeleton look more like a paragraph, the last line is set to 50% width.\n\n\n```html\n
\n
\n \n \n \n \n
\n
\n```\n\n \n\n### Line Width\nYou can adjust the line width by applying a size modifier class:\n| Width | Modifier Class | \n| ------------ | ------------|\n| Small, 25% | `.skeleton--sm` |\n| Medium, 50% | `.skeleton--md` |\n| Large, 75% | `.skeleton--lg` |\n| Full, 100% | `.skeleton--full` |\n\n\n\n``` html\n\n\n\n\n```\n\n \n\n### Alignment\nYou can text align the skeleton using alignment modifier classes:\n\n| Alignment | Modifier Class |\n| ------------ | ------------|\n| Left | `.skeleton--left` |\n| Center | `.skeleton--center` |\n| Right | `.skeleton--right` |\n\n\n\n``` html\n\n
\n \n \n \n \n
\n\n\n
\n \n \n \n \n
\n\n\n
\n \n \n \n \n
\n```\n\n \n\n### Images\nYou can create an image skeleton by adding the `.skeleton-image` class to an img tag -- do not include the `src` attribute. By default this will apply the image skeleton at 100% height and width of the parent container.\n\n#### Sizes\nHere are some default sizes we have included for skeleton images:\n\n| Size | Modifier Class |\n| ------------ | ------------| \n| Small, 50x50 | `.skeleton-image--sm` |\n| Medium, 100x100 | `.skeleton-image--md` |\n| Large, 200x200 | `.skeleton-image--lg` |\n| X-Large, 400x400 | `.skeleton-image--xl` |\n| Full, 100% x 100% | `.skeleton-image--full` |\n\n\n\n``` html\n\n\n\n\n```\n\n \n\n#### Shapes\nYou can also make different image shapes using shape modifier classes:\n\n| Shape | Description | Modifier Class |\n| ------------ |------------ | ------------| \n| Landscape Rectangle | Sets the width of the image to 100% | `.skeleton-image--landscape` |\n| Portrait Rectangle | Sets the height of the image to 100% | `.skeleton-image--portrait` |\n| Circle | Sets the border radius to 50% | `.skeleton-image--circle` |\n\n\n\n``` html\n\n\n\n```\n\n \n\n### Animation\nTo add animation, add a `span.skeleton--animation` within the `.skeleton__line` elements in headers or paragaphs.\n\n\n\n``` html\n
![](\"images/fish-skeleton.png\")
\n