Showing preview only (201K chars total). Download the full file or copy to clipboard to get everything.
Repository: shipshapecode/ember-shepherd
Branch: main
Commit: 41769b7e9312
Files: 99
Total size: 178.5 KB
Directory structure:
gitextract_y9qvqvon/
├── .editorconfig
├── .github/
│ ├── dependabot.yml
│ └── workflows/
│ ├── addon-docs.yml
│ ├── ci.yml
│ ├── plan-release.yml
│ ├── publish.yml
│ └── push-dist.yml
├── .gitignore
├── .npmrc
├── .prettierignore
├── .prettierrc.cjs
├── .release-plan.json
├── .tool-versions
├── CHANGELOG.md
├── CONTRIBUTING.md
├── LICENSE.md
├── README.md
├── RELEASE.md
├── config/
│ └── ember-cli-update.json
├── ember-shepherd/
│ ├── .gitignore
│ ├── .prettierignore
│ ├── .prettierrc.cjs
│ ├── .template-lintrc.cjs
│ ├── addon-main.cjs
│ ├── babel.config.json
│ ├── eslint.config.mjs
│ ├── package.json
│ ├── rollup.config.mjs
│ ├── src/
│ │ ├── .gitkeep
│ │ ├── index.ts
│ │ ├── services/
│ │ │ └── tour.ts
│ │ ├── template-registry.ts
│ │ ├── unpublished-development-types/
│ │ │ └── index.d.ts
│ │ └── utils/
│ │ ├── buttons.ts
│ │ └── dom.ts
│ ├── tsconfig.json
│ └── unpublished-development-types/
│ └── index.d.ts
├── package.json
├── pnpm-workspace.yaml
└── test-app/
├── .editorconfig
├── .ember-cli
├── .gitignore
├── .prettierignore
├── .prettierrc.js
├── .stylelintignore
├── .stylelintrc.js
├── .template-lintrc.js
├── .watchmanconfig
├── README.md
├── app/
│ ├── app.ts
│ ├── components/
│ │ └── .gitkeep
│ ├── config/
│ │ └── environment.d.ts
│ ├── controllers/
│ │ ├── .gitkeep
│ │ └── docs/
│ │ └── demo.js
│ ├── data.js
│ ├── deprecation-workflow.ts
│ ├── helpers/
│ │ └── .gitkeep
│ ├── index.html
│ ├── models/
│ │ └── .gitkeep
│ ├── router.js
│ ├── routes/
│ │ ├── .gitkeep
│ │ └── docs/
│ │ └── demo.js
│ ├── styles/
│ │ ├── app.css
│ │ ├── fonts.css
│ │ └── shepherd-theme.css
│ └── templates/
│ ├── application.hbs
│ ├── docs/
│ │ ├── demo.hbs
│ │ ├── faq.md
│ │ ├── index.md
│ │ ├── not-found.hbs
│ │ └── usage.md
│ ├── docs.hbs
│ └── index.hbs
├── config/
│ ├── addon-docs.js
│ ├── deploy.js
│ ├── ember-cli-update.json
│ ├── ember-try.js
│ ├── environment.js
│ ├── optional-features.json
│ └── targets.js
├── ember-cli-build.js
├── eslint.config.mjs
├── package.json
├── public/
│ ├── crossdomain.xml
│ └── robots.txt
├── testem.js
├── tests/
│ ├── acceptance/
│ │ └── ember-shepherd-test.js
│ ├── data.js
│ ├── helpers/
│ │ ├── index.js
│ │ └── index.ts
│ ├── index.html
│ ├── integration/
│ │ └── .gitkeep
│ ├── test-helper.js
│ ├── test-helper.ts
│ └── unit/
│ ├── .gitkeep
│ ├── services/
│ │ └── tour-test.js
│ └── utils/
│ └── make-button-test.js
├── tsconfig.json
└── types/
└── global.d.ts
================================================
FILE CONTENTS
================================================
================================================
FILE: .editorconfig
================================================
# EditorConfig helps developers define and maintain consistent
# coding styles between different editors and IDEs
# editorconfig.org
root = true
[*]
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
indent_style = space
indent_size = 2
[*.hbs]
insert_final_newline = false
[*.{diff,md}]
trim_trailing_whitespace = false
================================================
FILE: .github/dependabot.yml
================================================
version: 2
updates:
- package-ecosystem: npm
directory: "/"
schedule:
interval: daily
time: "10:00"
open-pull-requests-limit: 10
labels:
- dependencies
ignore:
- dependency-name: ember-cli
versions:
- ">= 0"
================================================
FILE: .github/workflows/addon-docs.yml
================================================
name: Publish Addon Docs
on:
push:
branches:
- main
- master
tags:
- "**"
jobs:
build:
env:
DEPLOY_KEY: ${{ secrets.DEPLOY_KEY }}
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
token: ${{ secrets.GITHUB_TOKEN }}
- name: Check for tags and set short-circuit condition
id: check-tags
run: |
# Fetch tags pointing to the current commit
TAGS=$(git tag --points-at $GITHUB_SHA)
echo "Tags found: $TAGS"
# Check if a tag exists and if the ref is 'refs/heads/main' or 'refs/heads/master'
if [ -n "$TAGS" ] && ([[ "${GITHUB_REF}" == "refs/heads/main" ]] || [[ "${GITHUB_REF}" == "refs/heads/master" ]]); then
echo "SHORT_CIRCUIT=true" >> $GITHUB_ENV
else
echo "SHORT_CIRCUIT=false" >> $GITHUB_ENV
fi
- uses: pnpm/action-setup@v4
if: env.SHORT_CIRCUIT == 'false'
with:
version: 10
- uses: actions/setup-node@v4
if: env.SHORT_CIRCUIT == 'false'
with:
node-version: 20
cache: pnpm
- name: Install Dependencies
if: env.SHORT_CIRCUIT == 'false'
run: pnpm install --no-lockfile
- name: Deploy Docs
if: env.SHORT_CIRCUIT == 'false'
run: |
cd test-app
pnpm ember deploy production
================================================
FILE: .github/workflows/ci.yml
================================================
name: CI
on:
push:
branches:
- main
- master
pull_request: {}
concurrency:
group: ci-${{ github.head_ref || github.ref }}
cancel-in-progress: true
jobs:
test:
name: "Tests"
runs-on: ubuntu-latest
timeout-minutes: 10
steps:
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v4
with:
version: 10
- uses: actions/setup-node@v4
with:
node-version: 20
cache: pnpm
- name: Install Dependencies
run: pnpm install --frozen-lockfile
- name: Lint
run: pnpm lint
- name: Run Tests
run: pnpm test
floating:
name: "Floating Dependencies"
runs-on: ubuntu-latest
timeout-minutes: 10
steps:
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v4
with:
version: 10
- uses: actions/setup-node@v4
with:
node-version: 20
cache: pnpm
- name: Install Dependencies
run: pnpm install --no-lockfile
- name: Run Tests
run: pnpm test
try-scenarios:
name: ${{ matrix.try-scenario }}
runs-on: ubuntu-latest
needs: 'test'
timeout-minutes: 10
strategy:
fail-fast: false
matrix:
try-scenario:
- ember-lts-4.8
- ember-lts-4.12
- ember-lts-5.4
- ember-release
- ember-beta
- ember-canary
- embroider-safe
- embroider-optimized
steps:
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v4
with:
version: 10
- uses: actions/setup-node@v4
with:
node-version: 20
cache: pnpm
- name: Install Dependencies
run: pnpm install --frozen-lockfile
- name: Run Tests
run: ./node_modules/.bin/ember try:one ${{ matrix.try-scenario }} --skip-cleanup
working-directory: test-app
================================================
FILE: .github/workflows/plan-release.yml
================================================
name: Plan Release
on:
workflow_dispatch:
push:
branches:
- main
- master
pull_request_target: # This workflow has permissions on the repo, do NOT run code from PRs in this workflow. See https://securitylab.github.com/research/github-actions-preventing-pwn-requests/
types:
- labeled
- unlabeled
concurrency:
group: plan-release # only the latest one of these should ever be running
cancel-in-progress: true
jobs:
should-run-release-plan-prepare:
name: Should we run release-plan prepare?
runs-on: ubuntu-latest
outputs:
should-prepare: ${{ steps.should-prepare.outputs.should-prepare }}
steps:
- uses: release-plan/actions/should-prepare-release@v1
with:
ref: 'main'
id: should-prepare
create-prepare-release-pr:
name: Create Prepare Release PR
runs-on: ubuntu-latest
timeout-minutes: 5
needs: should-run-release-plan-prepare
permissions:
contents: write
issues: read
pull-requests: write
if: needs.should-run-release-plan-prepare.outputs.should-prepare == 'true'
steps:
- uses: release-plan/actions/prepare@v1
name: Run release-plan prepare
with:
ref: 'main'
env:
GITHUB_AUTH: ${{ secrets.GITHUB_TOKEN }}
id: explanation
- uses: peter-evans/create-pull-request@v8
name: Create Prepare Release PR
with:
commit-message: "Prepare Release ${{ steps.explanation.outputs.new-version}} using 'release-plan'"
labels: "internal"
sign-commits: true
branch: release-preview
title: Prepare Release ${{ steps.explanation.outputs.new-version }}
body: |
This PR is a preview of the release that [release-plan](https://github.com/embroider-build/release-plan) has prepared. To release you should just merge this PR 👍
-----------------------------------------
${{ steps.explanation.outputs.text }}
================================================
FILE: .github/workflows/publish.yml
================================================
# For every push to the primary branch with .release-plan.json modified,
# runs release-plan.
name: Publish Stable
on:
workflow_dispatch:
push:
branches:
- main
- master
paths:
- '.release-plan.json'
concurrency:
group: publish-${{ github.head_ref || github.ref }}
cancel-in-progress: true
jobs:
publish:
name: "NPM Publish"
runs-on: ubuntu-latest
permissions:
contents: write
id-token: write
attestations: write
steps:
- uses: actions/checkout@v6
- uses: pnpm/action-setup@v4
with:
version: 9
- uses: actions/setup-node@v6
with:
node-version: 22
registry-url: 'https://registry.npmjs.org'
cache: pnpm
- run: npm install -g npm@latest # ensure that the globally installed npm is new enough to support OIDC
- run: pnpm install --frozen-lockfile
- name: Publish to NPM
run: NPM_CONFIG_PROVENANCE=true pnpm release-plan publish
env:
GITHUB_AUTH: ${{ secrets.GITHUB_TOKEN }}
================================================
FILE: .github/workflows/push-dist.yml
================================================
# Because this library needs to be built,
# we can't easily point package.json files at the git repo for easy cross-repo testing.
#
# This workflow brings back that capability by placing the compiled assets on a "dist" branch
# (configurable via the "branch" option below)
name: Push dist
on:
push:
branches:
- main
- master
jobs:
push-dist:
name: Push dist
permissions:
contents: write
runs-on: ubuntu-latest
timeout-minutes: 10
steps:
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v4
with:
version: 10
- uses: actions/setup-node@v4
with:
node-version: 20
cache: pnpm
- name: Install Dependencies
run: pnpm install --frozen-lockfile
- uses: kategengler/put-built-npm-package-contents-on-branch@v2.0.0
with:
branch: dist
token: ${{ secrets.GITHUB_TOKEN }}
working-directory: 'ember-shepherd'
================================================
FILE: .gitignore
================================================
# See https://help.github.com/ignore-files/ for more about ignoring files.
# dependencies
node_modules/
# misc
.env*
.pnp*
.pnpm-debug.log
.sass-cache
.eslintcache
coverage/
npm-debug.log*
yarn-error.log
# ember-try
/.node_modules.ember-try/
/package.json.ember-try
/package-lock.json.ember-try
/yarn.lock.ember-try
/pnpm-lock.ember-try.yaml
# addon-docs
deploy-test-app
================================================
FILE: .npmrc
================================================
####################
# super strict mode
####################
auto-install-peers=false
strict-peer-dependents=true
resolve-peers-from-workspace-root=false
################
# Optimizations
################
# Less strict, but required for tooling to not barf on duplicate peer trees.
# (many libraries declare the same peers, which resolve to the same
# versions)
dedupe-peer-dependents=true
public-hoist-pattern[]=ember-source
################
# Compatibility
################
# highest is what everyone is used to, but
# not ensuring folks are actually compatible with declared ranges.
resolution-mode=highest
================================================
FILE: .prettierignore
================================================
# Prettier is also run from each package, so the ignores here
# protect against files that may not be within a package
# misc
!.*
.lint-todo/
# ember-try
/.node_modules.ember-try/
/pnpm-lock.ember-try.yaml
================================================
FILE: .prettierrc.cjs
================================================
'use strict';
module.exports = {
plugins: ['prettier-plugin-ember-template-tag'],
singleQuote: true,
};
================================================
FILE: .release-plan.json
================================================
{
"solution": {
"ember-shepherd": {
"impact": "major",
"oldVersion": "17.3.1",
"newVersion": "18.0.0",
"tagName": "latest",
"constraints": [
{
"impact": "major",
"reason": "Appears in changelog section :boom: Breaking Change"
},
{
"impact": "patch",
"reason": "Appears in changelog section :house: Internal"
}
],
"pkgJSONPath": "./ember-shepherd/package.json"
}
},
"description": "## Release (2026-02-16)\n\n* ember-shepherd 18.0.0 (major)\n\n#### :boom: Breaking Change\n* `ember-shepherd`\n * [#1816](https://github.com/RobbieTheWagner/ember-shepherd/pull/1816) Update to shepherd.js 15 ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n * [#1815](https://github.com/RobbieTheWagner/ember-shepherd/pull/1815) Update license to AGPL ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n * [#1808](https://github.com/RobbieTheWagner/ember-shepherd/pull/1808) Drop support for Ember < 4.8 ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n#### :house: Internal\n* Other\n * [#1817](https://github.com/RobbieTheWagner/ember-shepherd/pull/1817) release-it -> release-plan ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n * [#1807](https://github.com/RobbieTheWagner/ember-shepherd/pull/1807) node 20 / pnpm 10 ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n* `ember-shepherd`\n * [#1729](https://github.com/RobbieTheWagner/ember-shepherd/pull/1729) Update blueprints ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n\n#### Committers: 1\n- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))\n"
}
================================================
FILE: .tool-versions
================================================
nodejs 20.20.0
pnpm 10.28.0
================================================
FILE: CHANGELOG.md
================================================
# Changelog
## Release (2026-02-16)
* ember-shepherd 18.0.0 (major)
#### :boom: Breaking Change
* `ember-shepherd`
* [#1816](https://github.com/RobbieTheWagner/ember-shepherd/pull/1816) Update to shepherd.js 15 ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
* [#1815](https://github.com/RobbieTheWagner/ember-shepherd/pull/1815) Update license to AGPL ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
* [#1808](https://github.com/RobbieTheWagner/ember-shepherd/pull/1808) Drop support for Ember < 4.8 ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
#### :house: Internal
* Other
* [#1817](https://github.com/RobbieTheWagner/ember-shepherd/pull/1817) release-it -> release-plan ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
* [#1807](https://github.com/RobbieTheWagner/ember-shepherd/pull/1807) node 20 / pnpm 10 ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
* `ember-shepherd`
* [#1729](https://github.com/RobbieTheWagner/ember-shepherd/pull/1729) Update blueprints ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
#### Committers: 1
- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
## v17.3.1 (2024-12-07)
#### :bug: Bug Fix
* [#1716](https://github.com/RobbieTheWagner/ember-shepherd/pull/1716) Ensure `tourObject` is defined before using it ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
#### :house: Internal
* [#1717](https://github.com/RobbieTheWagner/ember-shepherd/pull/1717) Run TypeScript blueprints ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
#### Committers: 1
- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
## v17.3.0 (2024-12-07)
#### :rocket: Enhancement
* [#1715](https://github.com/RobbieTheWagner/ember-shepherd/pull/1715) Add destructor and set container when testing ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
#### Committers: 1
- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
## v17.2.0 (2024-12-07)
#### :rocket: Enhancement
* [#1714](https://github.com/RobbieTheWagner/ember-shepherd/pull/1714) Add support for `stepsContainer` ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
#### Committers: 1
- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
## v17.1.4 (2024-12-06)
#### :bug: Bug Fix
* [#1712](https://github.com/RobbieTheWagner/ember-shepherd/pull/1712) Make button type optional ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
#### :house: Internal
* [#1713](https://github.com/RobbieTheWagner/ember-shepherd/pull/1713) Add addon-docs deploy action ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
#### Committers: 1
- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
## v17.1.3 (2024-11-27)
#### :bug: Bug Fix
* [#1711](https://github.com/RobbieTheWagner/ember-shepherd/pull/1711) Use tracked properties for everything ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
#### Committers: 1
- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
## v17.1.2 (2024-11-26)
#### :bug: Bug Fix
* [#1710](https://github.com/RobbieTheWagner/ember-shepherd/pull/1710) Use EmberShepherdStepOptions type for steps ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
#### Committers: 1
- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
## v17.1.1 (2024-11-26)
#### :bug: Bug Fix
* [#1709](https://github.com/RobbieTheWagner/ember-shepherd/pull/1709) Update button types ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
#### Committers: 1
- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
## v17.1.0 (2024-11-26)
#### :rocket: Enhancement
* [#1708](https://github.com/RobbieTheWagner/ember-shepherd/pull/1708) Add types ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
#### Committers: 1
- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
## v17.0.8 (2024-11-20)
## v17.0.7 (2024-11-20)
#### :house: Internal
* [#1707](https://github.com/RobbieTheWagner/ember-shepherd/pull/1707) Try embroider again ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
#### Committers: 1
- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
## v17.0.6 (2024-11-20)
## v17.0.5 (2024-11-19)
## v17.0.4 (2024-11-19)
#### :house: Internal
* [#1706](https://github.com/RobbieTheWagner/ember-shepherd/pull/1706) Go back to not full embroider ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
#### Committers: 1
- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
## v17.0.3 (2024-11-19)
## v17.0.2 (2024-11-19)
## v17.0.1 (2024-11-19)
## v17.0.0 (2024-11-19)
#### :boom: Breaking Change
* [#1705](https://github.com/RobbieTheWagner/ember-shepherd/pull/1705) Convert to v2 addon ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
#### Committers: 1
- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
## v16.0.0 (2024-11-19)
#### :boom: Breaking Change
* [#1693](https://github.com/RobbieTheWagner/ember-shepherd/pull/1693) Bump shepherd.js from 11.2.0 to 14.1.0 ([@dependabot[bot]](https://github.com/apps/dependabot))
#### :rocket: Enhancement
* [#1704](https://github.com/RobbieTheWagner/ember-shepherd/pull/1704) Add back support for Ember >= 4.4 ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
#### :memo: Documentation
* [#1703](https://github.com/RobbieTheWagner/ember-shepherd/pull/1703) Update demo and docs ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
* [#1689](https://github.com/RobbieTheWagner/ember-shepherd/pull/1689) Update README.md with working docs link ([@zion](https://github.com/zion))
#### :house: Internal
* [#1702](https://github.com/RobbieTheWagner/ember-shepherd/pull/1702) Disable embroider-optimized ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
* [#1701](https://github.com/RobbieTheWagner/ember-shepherd/pull/1701) Switch to pnpm ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
#### Committers: 2
- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
- Simeon ([@zion](https://github.com/zion))
## v15.0.0 (2024-03-28)
#### :boom: Breaking Change
* [#1636](https://github.com/RobbieTheWagner/ember-shepherd/pull/1636) Drop support for Ember < 4.8 and node < 18 ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
* [#1373](https://github.com/RobbieTheWagner/ember-shepherd/pull/1373) ember/ember-cli 4.12 drop support for Ember < 4.4 ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
#### Committers: 1
- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
## v14.0.0 (2022-11-30)
#### :boom: Breaking Change
* [#1237](https://github.com/RobbieTheWagner/ember-shepherd/pull/1237) Bump shepherd.js from 10.0.1 to 11.0.0 ([@dependabot[bot]](https://github.com/apps/dependabot))
#### :house: Internal
* [#1227](https://github.com/RobbieTheWagner/ember-shepherd/pull/1227) Pin ember-data ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
#### Committers: 1
- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
## v13.1.0 (2022-10-25)
#### :house: Internal
* [#1211](https://github.com/RobbieTheWagner/ember-shepherd/pull/1211) ESLint 8, ember-cli 4.8 ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
#### Committers: 1
- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
## v13.0.0 (2022-08-26)
#### :boom: Breaking Change
* [#1166](https://github.com/RobbieTheWagner/ember-shepherd/pull/1166) ember-cli 4.6, drop node 12 support ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
#### Committers: 1
- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
## v12.1.0 (2022-02-16)
#### :house: Internal
* [#983](https://github.com/RobbieTheWagner/ember-shepherd/pull/983) ember-cli 4.1.0 ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
* [#975](https://github.com/RobbieTheWagner/ember-shepherd/pull/975) ember-cli 4 ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
* [#952](https://github.com/RobbieTheWagner/ember-shepherd/pull/952) Ember 3.28 ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
* [#950](https://github.com/RobbieTheWagner/ember-shepherd/pull/950) Bump deps ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
#### Committers: 1
- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
## v12.0.0 (2021-09-16)
#### :boom: Breaking Change
* [#779](https://github.com/RobbieTheWagner/ember-shepherd/pull/779) Ember 3.26, ember-auto-import 2 ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
#### :house: Internal
* [#773](https://github.com/RobbieTheWagner/ember-shepherd/pull/773) Add dependabot automerge ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
* [#654](https://github.com/RobbieTheWagner/ember-shepherd/pull/654) Update eslint-plugin-ember, fix lint ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
#### Committers: 1
- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
## v11.0.2 (2020-12-14)
#### :memo: Documentation
* [#551](https://github.com/RobbieTheWagner/ember-shepherd/pull/551) Use the new CodeBlock format ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
#### :house: Internal
* [#634](https://github.com/RobbieTheWagner/ember-shepherd/pull/634) Switch from Travis to GitHub actions ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
* [#633](https://github.com/RobbieTheWagner/ember-shepherd/pull/633) Ember 3.22 ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
#### Committers: 1
- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
## v11.0.1 (2020-07-08)
#### :rocket: Enhancement
* [#450](https://github.com/RobbieTheWagner/ember-shepherd/pull/450) Add support for modalContainer, fix Tour options ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
#### :house: Internal
* [#516](https://github.com/RobbieTheWagner/ember-shepherd/pull/516) Add embroider tests ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
#### Committers: 1
- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
## v11.0.0 (2020-02-25)
#### :boom: Breaking Change
* [#432](https://github.com/RobbieTheWagner/ember-shepherd/pull/432) Shepherd.js v7 ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
#### Committers: 1
- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
## v9.0.0 (2019-08-29)
#### :boom: Breaking Change
* [#338](https://github.com/RobbieTheWagner/ember-shepherd/pull/338) Shepherd 5.x ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
#### Committers: 1
- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
## v8.0.0 (2019-08-01)
#### :boom: Breaking Change
* [#333](https://github.com/RobbieTheWagner/ember-shepherd/pull/333) Shepherd 4 ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
#### Committers: 1
- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
## v7.0.0 (2019-06-23)
#### :boom: Breaking Change
* [#325](https://github.com/RobbieTheWagner/ember-shepherd/pull/325) Remove body-scroll-lock, shepherd.js 3.0.0 ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
#### :rocket: Enhancement
* [#325](https://github.com/RobbieTheWagner/ember-shepherd/pull/325) Remove body-scroll-lock, shepherd.js 3.0.0 ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
#### Committers: 1
- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
## v6.0.0 (2019-05-26)
#### :boom: Breaking Change
* [#316](https://github.com/RobbieTheWagner/ember-shepherd/pull/316) Ember 3.10, drop support for node 6 ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
#### :rocket: Enhancement
* [#317](https://github.com/RobbieTheWagner/ember-shepherd/pull/317) Shepherd.js 2.9.0, bump other deps ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
#### Committers: 1
- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
## v5.0.0 (2019-05-03)
#### :boom: Breaking Change
* [#305](https://github.com/RobbieTheWagner/ember-shepherd/pull/305) load shepherd.js lazily using ember-auto-import ([@st-h](https://github.com/st-h))
#### :rocket: Enhancement
* [#307](https://github.com/RobbieTheWagner/ember-shepherd/pull/307) replace fastboot guards with an initializer ([@st-h](https://github.com/st-h))
* [#305](https://github.com/RobbieTheWagner/ember-shepherd/pull/305) load shepherd.js lazily using ember-auto-import ([@st-h](https://github.com/st-h))
#### Committers: 2
- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
- Steve ([@st-h](https://github.com/st-h))
## v4.9.0 (2019-04-15)
#### :rocket: Enhancement
* [#302](https://github.com/RobbieTheWagner/ember-shepherd/pull/302) Update to Shepherd 2.6.0 ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
#### Committers: 1
- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
## v4.8.0 (2019-04-06)
#### :rocket: Enhancement
* [#297](https://github.com/RobbieTheWagner/ember-shepherd/pull/297) Use ember-cli-addon-docs for documentation ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
#### Committers: 1
- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
## v4.7.0 (2019-04-05)
#### :rocket: Enhancement
* [#295](https://github.com/RobbieTheWagner/ember-shepherd/pull/295) Use rootElement, if defined, rather than document.body ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
* [#296](https://github.com/RobbieTheWagner/ember-shepherd/pull/296) Use ember-auto-import to import disable-scroll, bump disable-scroll to 0.4.1 ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
#### Committers: 1
- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
## v4.1.0 (2019-01-02)
#### :rocket: Enhancement
* [#282](https://github.com/RobbieTheWagner/ember-shepherd/pull/282) feat: Pass tourName option when initializing the Shepherd.Tour ([@scottkidder](https://github.com/scottkidder))
#### Committers: 1
- Scott Kidder ([@scottkidder](https://github.com/scottkidder))
## v4.0.0-beta.14 (2018-11-09)
#### :rocket: Enhancement
* [#261](https://github.com/RobbieTheWagner/ember-shepherd/pull/261) Add method to hide current step ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
* [#239](https://github.com/RobbieTheWagner/ember-shepherd/pull/239) Document required elements order; add requiredElements tests ([@BrianSipple](https://github.com/BrianSipple))
#### Committers: 3
- Brian Sipple ([@BrianSipple](https://github.com/BrianSipple))
- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
- Scott Kidder ([@scottkidder](https://github.com/scottkidder))
## v4.0.0-beta.11 (2018-10-08)
#### :boom: Breaking Change
* [#248](https://github.com/RobbieTheWagner/ember-shepherd/pull/248) Implement SVG-based modal mode ([@BrianSipple](https://github.com/BrianSipple))
#### :rocket: Enhancement
* [#256](https://github.com/RobbieTheWagner/ember-shepherd/pull/256) Update project to use shepherd versions with Tippy ([@BrianSipple](https://github.com/BrianSipple))
* [#253](https://github.com/RobbieTheWagner/ember-shepherd/pull/253) Fix css rules for pointer-events ([@BrianSipple](https://github.com/BrianSipple))
* [#252](https://github.com/RobbieTheWagner/ember-shepherd/pull/252) Block clicks outside of visible modal opening. ([@BrianSipple](https://github.com/BrianSipple))
* [#250](https://github.com/RobbieTheWagner/ember-shepherd/pull/250) Hide modal when hiding the current step ([@BrianSipple](https://github.com/BrianSipple))
#### :bug: Bug Fix
* [#251](https://github.com/RobbieTheWagner/ember-shepherd/pull/251) Use Ember.set to set `this.tourObject` ([@BrianSipple](https://github.com/BrianSipple))
* [#247](https://github.com/RobbieTheWagner/ember-shepherd/pull/247) Remove cleanupShepherdElements ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
#### Committers: 2
- Brian Sipple ([@BrianSipple](https://github.com/BrianSipple))
- Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
## v4.0.0-beta.10 (2018-09-14)
#### :boom: Breaking Change
* [#241](https://github.com/RobbieTheWagner/ember-shepherd/pull/241) Change builtInButtons to buttons ([@chuckcarpenter](https://github.com/chuckcarpenter))
#### Committers: 1
- Chuck Carpenter ([@chuckcarpenter](https://github.com/chuckcarpenter))
## v4.0.0-beta.9 (2018-09-13)
#### :boom: Breaking Change
* [#243](https://github.com/RobbieTheWagner/ember-shepherd/pull/243) Rename `defaults` to `defaultStepOptions`. ([@BrianSipple](https://github.com/BrianSipple))
* [#245](https://github.com/RobbieTheWagner/ember-shepherd/pull/245) Stop disabling target element pointer events ([@BrianSipple](https://github.com/BrianSipple))
#### Committers: 1
- Brian Sipple ([@BrianSipple](https://github.com/BrianSipple))
## v4.0.0-beta.8 (2018-09-07)
#### :rocket: Enhancement
* [#237](https://github.com/RobbieTheWagner/ember-shepherd/pull/237) remove required buttons options ([@chuckcarpenter](https://github.com/chuckcarpenter))
#### Committers: 1
- Chuck Carpenter ([@chuckcarpenter](https://github.com/chuckcarpenter))
================================================
FILE: CONTRIBUTING.md
================================================
# How To Contribute
## Installation
- `git clone <repository-url>`
- `cd ember-shepherd`
- `pnpm install`
## Linting
- `pnpm lint`
- `pnpm lint:fix`
## Building the addon
- `cd ember-shepherd`
- `pnpm build`
## Running tests
- `cd test-app`
- `pnpm test` – Runs the test suite on the current Ember version
- `pnpm test:watch` – Runs the test suite in "watch mode"
## Running the test application
- `cd test-app`
- `pnpm start`
- Visit the test application at [http://localhost:4200](http://localhost:4200).
For more information on using ember-cli, visit [https://cli.emberjs.com/release/](https://cli.emberjs.com/release/).
================================================
FILE: LICENSE.md
================================================
# Shepherd.js License
Shepherd.js is dual-licensed under **AGPL-3.0** (for open source and non-commercial use) and a **Commercial License** (for commercial use).
---
🆓 Free Use - AGPL-3.0 License
You may use Shepherd.js **FREE OF CHARGE** under the AGPL-3.0 license if you are:
✅ Open Source Projects
- Your project is open source and licensed under an AGPL-compatible license (GPL, AGPL, etc.)
- Your complete source code is publicly available
✅ Personal & Non-Commercial Use
- Personal projects, portfolios, and hobby websites
- Educational purposes (students, teachers, coursework)
- Academic research projects
✅ Evaluation & Testing
- Evaluating Shepherd.js for up to 30 days
- Development, testing, and staging environments during evaluation
- Proof-of-concept and demo projects
**Important:** If you use Shepherd.js under AGPL-3.0, you must:
- Make your complete source code available if you distribute or provide your software over a network
- License your code under AGPL-3.0 or a compatible license
- Comply with all AGPL-3.0 terms (see full license text below)
---
💳 Commercial License Required
You **must purchase a commercial license** at [shepherdjs.dev/pricing](https://shepherdjs.dev/pricing) if:
❌ Commercial Products & Services
- You're building a commercial product, application, SaaS, or website that generates revenue
- Your company generates revenue (even if the specific project using Shepherd.js does not)
- You're using Shepherd.js in any customer-facing commercial application
❌ Closed-Source Use
- You cannot or don't want to open-source your code under AGPL-3.0
- You want to keep your source code proprietary
- You want to avoid AGPL's source code disclosure requirements
❌ White-Label, Resale, or OEM Use
- You're embedding Shepherd.js in a product you sell or distribute
- You're offering Shepherd.js as part of a commercial service or hosting
- You're using Shepherd.js in a product sold to other businesses
❌ Internal Business Tools
- You're using Shepherd.js for internal tools, dashboards, or admin panels in a revenue-generating company
- Even if the tool is not customer-facing, commercial licenses are required for for-profit companies
**Why Commercial License?**
- ✅ No AGPL obligations - keep your code proprietary
- ✅ Legal protection and indemnification
- ✅ Priority support and updates
- ✅ Lifetime license with no recurring fees
[**Purchase Commercial License →**](https://shepherdjs.dev/pricing)
---
❓ Still Not Sure?
If you're unsure whether you need a commercial license:
- **Contact us:** [ahoy@shipshape.io](mailto:ahoy@shipshape.io)
- **View pricing:** [shepherdjs.dev/pricing](https://shepherdjs.dev/pricing)
**When in doubt:** If your organization generates revenue, you likely need a commercial license.
---
### GNU AFFERO GENERAL PUBLIC LICENSE
Version 3, 19 November 2007
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies of this license
document, but changing it is not allowed.
### Preamble
The GNU Affero General Public License is a free, copyleft license for software
and other kinds of works, specifically designed to ensure cooperation with the
community in the case of network server software.
The licenses for most software and other practical works are designed to take
away your freedom to share and change the works. By contrast, our General Public
Licenses are intended to guarantee your freedom to share and change all versions
of a program--to make sure it remains free software for all its users.
When we speak of free software, we are referring to freedom, not price. Our
General Public Licenses are designed to make sure that you have the freedom to
distribute copies of free software (and charge for them if you wish), that you
receive source code or can get it if you want it, that you can change the
software or use pieces of it in new free programs, and that you know you can do
these things.
Developers that use our General Public Licenses protect your rights with two
steps: (1) assert copyright on the software, and (2) offer you this License
which gives you legal permission to copy, distribute and/or modify the software.
A secondary benefit of defending all users' freedom is that improvements made in
alternate versions of the program, if they receive widespread use, become
available for other developers to incorporate. Many developers of free software
are heartened and encouraged by the resulting cooperation. However, in the case
of software used on network servers, this result may fail to come about. The GNU
General Public License permits making a modified version and letting the public
access it on a server without ever releasing its source code to the public.
The GNU Affero General Public License is designed specifically to ensure that,
in such cases, the modified source code becomes available to the community. It
requires the operator of a network server to provide the source code of the
modified version running there to the users of that server. Therefore, public
use of a modified version, on a publicly accessible server, gives the public
access to the source code of the modified version.
An older license, called the Affero General Public License and published by
Affero, was designed to accomplish similar goals. This is a different license,
not a version of the Affero GPL, but Affero has released a new version of the
Affero GPL which permits relicensing under this license.
The precise terms and conditions for copying, distribution and modification
follow.
### TERMS AND CONDITIONS
#### 0. Definitions.
"This License" refers to version 3 of the GNU Affero General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of works,
such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this License. Each
licensee is addressed as "you". "Licensees" and "recipients" may be individuals
or organizations.
To "modify" a work means to copy from or adapt all or part of the work in a
fashion requiring copyright permission, other than the making of an exact copy.
The resulting work is called a "modified version" of the earlier work or a work
"based on" the earlier work.
A "covered work" means either the unmodified Program or a work based on the
Program.
To "propagate" a work means to do anything with it that, without permission,
would make you directly or secondarily liable for infringement under applicable
copyright law, except executing it on a computer or modifying a private copy.
Propagation includes copying, distribution (with or without modification),
making available to the public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other parties to
make or receive copies. Mere interaction with a user through a computer network,
with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices" to the extent
that it includes a convenient and prominently visible feature that (1) displays
an appropriate copyright notice, and (2) tells the user that there is no
warranty for the work (except to the extent that warranties are provided), that
licensees may convey the work under this License, and how to view a copy of this
License. If the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
#### 1. Source Code.
The "source code" for a work means the preferred form of the work for making
modifications to it. "Object code" means any non-source form of a work.
A "Standard Interface" means an interface that either is an official standard
defined by a recognized standards body, or, in the case of interfaces specified
for a particular programming language, one that is widely used among developers
working in that language.
The "System Libraries" of an executable work include anything, other than the
work as a whole, that (a) is included in the normal form of packaging a Major
Component, but which is not part of that Major Component, and (b) serves only to
enable use of the work with that Major Component, or to implement a Standard
Interface for which an implementation is available to the public in source code
form. A "Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system (if any) on
which the executable work runs, or a compiler used to produce the work, or an
object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all the source
code needed to generate, install, and (for an executable work) run the object
code and to modify the work, including scripts to control those activities.
However, it does not include the work's System Libraries, or general-purpose
tools or generally available free programs which are used unmodified in
performing those activities but which are not part of the work. For example,
Corresponding Source includes interface definition files associated with source
files for the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require, such as by
intimate data communication or control flow between those subprograms and other
parts of the work.
The Corresponding Source need not include anything that users can regenerate
automatically from other parts of the Corresponding Source.
The Corresponding Source for a work in source code form is that same work.
#### 2. Basic Permissions.
All rights granted under this License are granted for the term of copyright on
the Program, and are irrevocable provided the stated conditions are met. This
License explicitly affirms your unlimited permission to run the unmodified
Program. The output from running a covered work is covered by this License only
if the output, given its content, constitutes a covered work. This License
acknowledges your rights of fair use or other equivalent, as provided by
copyright law.
You may make, run and propagate covered works that you do not convey, without
conditions so long as your license otherwise remains in force. You may convey
covered works to others for the sole purpose of having them make modifications
exclusively for you, or provide you with facilities for running those works,
provided that you comply with the terms of this License in conveying all
material for which you do not control copyright. Those thus making or running
the covered works for you must do so exclusively on your behalf, under your
direction and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under the conditions
stated below. Sublicensing is not allowed; section 10 makes it unnecessary.
#### 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological measure under
any applicable law fulfilling obligations under article 11 of the WIPO copyright
treaty adopted on 20 December 1996, or similar laws prohibiting or restricting
circumvention of such measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention is
effected by exercising rights under this License with respect to the covered
work, and you disclaim any intention to limit operation or modification of the
work as a means of enforcing, against the work's users, your or third parties'
legal rights to forbid circumvention of technological measures.
#### 4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you receive it,
in any medium, provided that you conspicuously and appropriately publish on each
copy an appropriate copyright notice; keep intact all notices stating that this
License and any non-permissive terms added in accord with section 7 apply to the
code; keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey, and you may
offer support or warranty protection for a fee.
#### 5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to produce it
from the Program, in the form of source code under the terms of section 4,
provided that you also meet all of these conditions:
- a) The work must carry prominent notices stating that you modified it, and
giving a relevant date.
- b) The work must carry prominent notices stating that it is released under
this License and any conditions added under section 7. This requirement
modifies the requirement in section 4 to "keep intact all notices".
- c) You must license the entire work, as a whole, under this License to anyone
who comes into possession of a copy. This License will therefore apply, along
with any applicable section 7 additional terms, to the whole of the work, and
all its parts, regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not invalidate
such permission if you have separately received it.
- d) If the work has interactive user interfaces, each must display Appropriate
Legal Notices; however, if the Program has interactive interfaces that do not
display Appropriate Legal Notices, your work need not make them do so.
A compilation of a covered work with other separate and independent works, which
are not by their nature extensions of the covered work, and which are not
combined with it such as to form a larger program, in or on a volume of a
storage or distribution medium, is called an "aggregate" if the compilation and
its resulting copyright are not used to limit the access or legal rights of the
compilation's users beyond what the individual works permit. Inclusion of a
covered work in an aggregate does not cause this License to apply to the other
parts of the aggregate.
#### 6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms of sections 4
and 5, provided that you also convey the machine-readable Corresponding Source
under the terms of this License, in one of these ways:
- a) Convey the object code in, or embodied in, a physical product (including a
physical distribution medium), accompanied by the Corresponding Source fixed
on a durable physical medium customarily used for software interchange.
- b) Convey the object code in, or embodied in, a physical product (including a
physical distribution medium), accompanied by a written offer, valid for at
least three years and valid for as long as you offer spare parts or customer
support for that product model, to give anyone who possesses the object code
either (1) a copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical medium
customarily used for software interchange, for a price no more than your
reasonable cost of physically performing this conveying of source, or (2)
access to copy the Corresponding Source from a network server at no charge.
- c) Convey individual copies of the object code with a copy of the written
offer to provide the Corresponding Source. This alternative is allowed only
occasionally and noncommercially, and only if you received the object code
with such an offer, in accord with subsection 6b.
- d) Convey the object code by offering access from a designated place (gratis
or for a charge), and offer equivalent access to the Corresponding Source in
the same way through the same place at no further charge. You need not require
recipients to copy the Corresponding Source along with the object code. If the
place to copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party) that supports
equivalent copying facilities, provided you maintain clear directions next to
the object code saying where to find the Corresponding Source. Regardless of
what server hosts the Corresponding Source, you remain obligated to ensure
that it is available for as long as needed to satisfy these requirements.
- e) Convey the object code using peer-to-peer transmission, provided you inform
other peers where the object code and Corresponding Source of the work are
being offered to the general public at no charge under subsection 6d.
A separable portion of the object code, whose source code is excluded from the
Corresponding Source as a System Library, need not be included in conveying the
object code work.
A "User Product" is either (1) a "consumer product", which means any tangible
personal property which is normally used for personal, family, or household
purposes, or (2) anything designed or sold for incorporation into a dwelling. In
determining whether a product is a consumer product, doubtful cases shall be
resolved in favor of coverage. For a particular product received by a particular
user, "normally used" refers to a typical or common use of that class of
product, regardless of the status of the particular user or of the way in which
the particular user actually uses, or expects or is expected to use, the
product. A product is a consumer product regardless of whether the product has
substantial commercial, industrial or non-consumer uses, unless such uses
represent the only significant mode of use of the product.
"Installation Information" for a User Product means any methods, procedures,
authorization keys, or other information required to install and execute
modified versions of a covered work in that User Product from a modified version
of its Corresponding Source. The information must suffice to ensure that the
continued functioning of the modified object code is in no case prevented or
interfered with solely because modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as part of a
transaction in which the right of possession and use of the User Product is
transferred to the recipient in perpetuity or for a fixed term (regardless of
how the transaction is characterized), the Corresponding Source conveyed under
this section must be accompanied by the Installation Information. But this
requirement does not apply if neither you nor any third party retains the
ability to install modified object code on the User Product (for example, the
work has been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates for a
work that has been modified or installed by the recipient, or for the User
Product in which it has been modified or installed. Access to a network may be
denied when the modification itself materially and adversely affects the
operation of the network or violates the rules and protocols for communication
across the network.
Corresponding Source conveyed, and Installation Information provided, in accord
with this section must be in a format that is publicly documented (and with an
implementation available to the public in source code form), and must require no
special password or key for unpacking, reading or copying.
#### 7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this License by
making exceptions from one or more of its conditions. Additional permissions
that are applicable to the entire Program shall be treated as though they were
included in this License, to the extent that they are valid under applicable
law. If additional permissions apply only to part of the Program, that part may
be used separately under those permissions, but the entire Program remains
governed by this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option remove any
additional permissions from that copy, or from any part of it. (Additional
permissions may be written to require their own removal in certain cases when
you modify the work.) You may place additional permissions on material, added by
you to a covered work, for which you have or can give appropriate copyright
permission.
Notwithstanding any other provision of this License, for material you add to a
covered work, you may (if authorized by the copyright holders of that material)
supplement the terms of this License with terms:
- a) Disclaiming warranty or limiting liability differently from the terms of
sections 15 and 16 of this License; or
- b) Requiring preservation of specified reasonable legal notices or author
attributions in that material or in the Appropriate Legal Notices displayed by
works containing it; or
- c) Prohibiting misrepresentation of the origin of that material, or requiring
that modified versions of such material be marked in reasonable ways as
different from the original version; or
- d) Limiting the use for publicity purposes of names of licensors or authors of
the material; or
- e) Declining to grant rights under trademark law for use of some trade names,
trademarks, or service marks; or
- f) Requiring indemnification of licensors and authors of that material by
anyone who conveys the material (or modified versions of it) with contractual
assumptions of liability to the recipient, for any liability that these
contractual assumptions directly impose on those licensors and authors.
All other non-permissive additional terms are considered "further restrictions"
within the meaning of section 10. If the Program as you received it, or any part
of it, contains a notice stating that it is governed by this License along with
a term that is a further restriction, you may remove that term. If a license
document contains a further restriction but permits relicensing or conveying
under this License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does not survive
such relicensing or conveying.
If you add terms to a covered work in accord with this section, you must place,
in the relevant source files, a statement of the additional terms that apply to
those files, or a notice indicating where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the form of a
separately written license, or stated as exceptions; the above requirements
apply either way.
#### 8. Termination.
You may not propagate or modify a covered work except as expressly provided
under this License. Any attempt otherwise to propagate or modify it is void, and
will automatically terminate your rights under this License (including any
patent licenses granted under the third paragraph of section 11).
However, if you cease all violation of this License, then your license from a
particular copyright holder is reinstated (a) provisionally, unless and until
the copyright holder explicitly and finally terminates your license, and (b)
permanently, if the copyright holder fails to notify you of the violation by
some reasonable means prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is reinstated
permanently if the copyright holder notifies you of the violation by some
reasonable means, this is the first time you have received notice of violation
of this License (for any work) from that copyright holder, and you cure the
violation prior to 30 days after your receipt of the notice.
Termination of your rights under this section does not terminate the licenses of
parties who have received copies or rights from you under this License. If your
rights have been terminated and not permanently reinstated, you do not qualify
to receive new licenses for the same material under section 10.
#### 9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or run a copy of
the Program. Ancillary propagation of a covered work occurring solely as a
consequence of using peer-to-peer transmission to receive a copy likewise does
not require acceptance. However, nothing other than this License grants you
permission to propagate or modify any covered work. These actions infringe
copyright if you do not accept this License. Therefore, by modifying or
propagating a covered work, you indicate your acceptance of this License to do
so.
#### 10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically receives a
license from the original licensors, to run, modify and propagate that work,
subject to this License. You are not responsible for enforcing compliance by
third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered work results
from an entity transaction, each party to that transaction who receives a copy
of the work also receives whatever licenses to the work the party's predecessor
in interest had or could give under the previous paragraph, plus a right to
possession of the Corresponding Source of the work from the predecessor in
interest, if the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the rights
granted or affirmed under this License. For example, you may not impose a
license fee, royalty, or other charge for exercise of rights granted under this
License, and you may not initiate litigation (including a cross-claim or
counterclaim in a lawsuit) alleging that any patent claim is infringed by
making, using, selling, offering for sale, or importing the Program or any
portion of it.
#### 11. Patents.
A "contributor" is a copyright holder who authorizes use under this License of
the Program or a work on which the Program is based. The work thus licensed is
called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims owned or
controlled by the contributor, whether already acquired or hereafter acquired,
that would be infringed by some manner, permitted by this License, of making,
using, or selling its contributor version, but do not include claims that would
be infringed only as a consequence of further modification of the contributor
version. For purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free patent
license under the contributor's essential patent claims, to make, use, sell,
offer for sale, import and otherwise run, modify and propagate the contents of
its contributor version.
In the following three paragraphs, a "patent license" is any express agreement
or commitment, however denominated, not to enforce a patent (such as an express
permission to practice a patent or covenant not to sue for patent infringement).
To "grant" such a patent license to a party means to make such an agreement or
commitment not to enforce a patent against the party.
If you convey a covered work, knowingly relying on a patent license, and the
Corresponding Source of the work is not available for anyone to copy, free of
charge and under the terms of this License, through a publicly available network
server or other readily accessible means, then you must either (1) cause the
Corresponding Source to be so available, or (2) arrange to deprive yourself of
the benefit of the patent license for this particular work, or (3) arrange, in a
manner consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have actual
knowledge that, but for the patent license, your conveying the covered work in a
country, or your recipient's use of the covered work in a country, would
infringe one or more identifiable patents in that country that you have reason
to believe are valid.
If, pursuant to or in connection with a single transaction or arrangement, you
convey, or propagate by procuring conveyance of, a covered work, and grant a
patent license to some of the parties receiving the covered work authorizing
them to use, propagate, modify or convey a specific copy of the covered work,
then the patent license you grant is automatically extended to all recipients of
the covered work and works based on it.
A patent license is "discriminatory" if it does not include within the scope of
its coverage, prohibits the exercise of, or is conditioned on the non-exercise
of one or more of the rights that are specifically granted under this License.
You may not convey a covered work if you are a party to an arrangement with a
third party that is in the business of distributing software, under which you
make payment to the third party based on the extent of your activity of
conveying the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory patent
license (a) in connection with copies of the covered work conveyed by you (or
copies made from those copies), or (b) primarily for and in connection with
specific products or compilations that contain the covered work, unless you
entered into that arrangement, or that patent license was granted, prior to 28
March 2007.
Nothing in this License shall be construed as excluding or limiting any implied
license or other defenses to infringement that may otherwise be available to you
under applicable patent law.
#### 12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not excuse
you from the conditions of this License. If you cannot convey a covered work so
as to satisfy simultaneously your obligations under this License and any other
pertinent obligations, then as a consequence you may not convey it at all. For
example, if you agree to terms that obligate you to collect a royalty for
further conveying from those to whom you convey the Program, the only way you
could satisfy both those terms and this License would be to refrain entirely
from conveying the Program.
#### 13. Remote Network Interaction; Use with the GNU General Public License.
Notwithstanding any other provision of this License, if you modify the Program,
your modified version must prominently offer all users interacting with it
remotely through a computer network (if your version supports such interaction)
an opportunity to receive the Corresponding Source of your version by providing
access to the Corresponding Source from a network server at no charge, through
some standard or customary means of facilitating copying of software. This
Corresponding Source shall include the Corresponding Source for any work covered
by version 3 of the GNU General Public License that is incorporated pursuant to
the following paragraph.
Notwithstanding any other provision of this License, you have permission to link
or combine any covered work with a work licensed under version 3 of the GNU
General Public License into a single combined work, and to convey the resulting
work. The terms of this License will continue to apply to the part which is the
covered work, but the work with which it is combined will remain governed by
version 3 of the GNU General Public License.
#### 14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of the GNU
Affero General Public License from time to time. Such new versions will be
similar in spirit to the present version, but may differ in detail to address
new problems or concerns.
Each version is given a distinguishing version number. If the Program specifies
that a certain numbered version of the GNU Affero General Public License "or any
later version" applies to it, you have the option of following the terms and
conditions either of that numbered version or of any later version published by
the Free Software Foundation. If the Program does not specify a version number
of the GNU Affero General Public License, you may choose any version ever
published by the Free Software Foundation.
If the Program specifies that a proxy can decide which future versions of the
GNU Affero General Public License can be used, that proxy's public statement of
acceptance of a version permanently authorizes you to choose that version for
the Program.
Later license versions may give you additional or different permissions.
However, no additional obligations are imposed on any author or copyright holder
as a result of your choosing to follow a later version.
#### 15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER
PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE
QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE
DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
#### 16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY
COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS
PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL,
INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED
INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE
PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY
HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
#### 17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided above cannot
be given local legal effect according to their terms, reviewing courts shall
apply local law that most closely approximates an absolute waiver of all civil
liability in connection with the Program, unless a warranty or assumption of
liability accompanies a copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
### How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest possible use
to the public, the best way to achieve this is to make it free software which
everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest to attach
them to the start of each source file to most effectively state the exclusion of
warranty; and each file should have at least the "copyright" line and a pointer
to where the full notice is found.
Better introductions for websites and features with a step-by-step guide for your projects.
Copyright (C) 2012-2021 Afshin Mehrabani
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If your software can interact with users remotely through a computer network,
you should also make sure that it provides a way for users to get its source.
For example, if your program is a web application, its interface could display a
"Source" link that leads users to an archive of the code. There are many ways
you could offer source, and different solutions will be better for different
programs; see section 13 for the specific requirements.
You should also get your employer (if you work as a programmer) or school, if
any, to sign a "copyright disclaimer" for the program, if necessary. For more
information on this, and how to apply and follow the GNU AGPL, see
<https://www.gnu.org/licenses/>.
================================================
FILE: README.md
================================================
# ember-shepherd
<a href="https://shipshape.io/"><img src="http://i.imgur.com/DWHQjA5.png" alt="Ship Shape" width="100" height="100"/></a>
**[ember-shepherd is built and maintained by Ship Shape. Contact us for Ember.js consulting, development, and training for your project](https://shipshape.io/ember-consulting/)**.
[](http://badge.fury.io/js/ember-shepherd)
[]()
[](http://emberobserver.com/addons/ember-shepherd)
[](https://github.com/RobbieTheWagner/ember-shepherd/actions/workflows/ci.yml)
This is an Ember wrapper for the [Shepherd](https://github.com/shipshapecode/shepherd), site tour, library. It provides additional functionality, on top of Shepherd, as well.
## Compatibility
- Ember.js v4.8 or above
- Ember CLI v4.8 or above
## Installation
```
ember install ember-shepherd
```
## Documentation
[View Docs](https://RobbieTheWagner.github.io/ember-shepherd/)
## Contributing
See the [Contributing](CONTRIBUTING.md) guide for details.
## License
`ember-shepherd` is licensed under **AGPL-3.0** (for open source and non-commercial use) with a **Commercial License** available for commercial use.
- **Free** for open source and non-commercial projects under AGPL-3.0
- **Commercial license required** for commercial products and revenue-generating companies
📄 [Read License Details](LICENSE.md)
💳 [Purchase Commercial License](https://shepherdjs.dev/pricing)
================================================
FILE: RELEASE.md
================================================
# Release Process
Releases in this repo are mostly automated using [release-plan](https://github.com/embroider-build/release-plan/). Once you label all your PRs correctly (see below) you will have an automatically generated PR that updates your CHANGELOG.md file and a `.release-plan.json` that is used to prepare the release once the PR is merged.
## Preparation
Since the majority of the actual release process is automated, the remaining tasks before releasing are:
- correctly labeling **all** pull requests that have been merged since the last release
- updating pull request titles so they make sense to our users
Some great information on why this is important can be found at [keepachangelog.com](https://keepachangelog.com/en/1.1.0/), but the overall
guiding principle here is that changelogs are for humans, not machines.
When reviewing merged PR's the labels to be used are:
- breaking - Used when the PR is considered a breaking change.
- enhancement - Used when the PR adds a new feature or enhancement.
- bug - Used when the PR fixes a bug included in a previous release.
- documentation - Used when the PR adds or updates documentation.
- internal - Internal changes or things that don't fit in any other category.
**Note:** `release-plan` requires that **all** PRs are labeled. If a PR doesn't fit in a category it's fine to label it as `internal`
## Release
Once the prep work is completed, the actual release is straight forward: you just need to merge the open [Plan Release](https://github.com/RobbieTheWagner/ember-shepherd/pulls?q=is%3Apr+is%3Aopen+%22Prepare+Release%22+in%3Atitle) PR
================================================
FILE: config/ember-cli-update.json
================================================
{
"schemaVersion": "1.0.0",
"projectName": "ember-shepherd",
"packages": [
{
"name": "@embroider/addon-blueprint",
"version": "4.1.2",
"blueprints": [
{
"name": "@embroider/addon-blueprint",
"isBaseBlueprint": true,
"options": [
"--ci-provider=github",
"--pnpm",
"--typescript"
]
}
]
}
]
}
================================================
FILE: ember-shepherd/.gitignore
================================================
# The authoritative copies of these live in the monorepo root (because they're
# more useful on github that way), but the build copies them into here so they
# will also appear in published NPM packages.
/README.md
/LICENSE.md
# compiled output
dist/
declarations/
# npm/pnpm/yarn pack output
*.tgz
# deps & caches
node_modules/
.eslintcache
.prettiercache
================================================
FILE: ember-shepherd/.prettierignore
================================================
# unconventional js
/blueprints/*/files/
# compiled output
/dist/
/declarations/
# misc
/coverage/
================================================
FILE: ember-shepherd/.prettierrc.cjs
================================================
'use strict';
module.exports = {
plugins: ['prettier-plugin-ember-template-tag'],
overrides: [
{
files: '*.{js,gjs,ts,gts,mjs,mts,cjs,cts}',
options: {
singleQuote: true,
templateSingleQuote: false,
},
},
],
};
================================================
FILE: ember-shepherd/.template-lintrc.cjs
================================================
'use strict';
module.exports = {
extends: 'recommended',
};
================================================
FILE: ember-shepherd/addon-main.cjs
================================================
'use strict';
const { addonV1Shim } = require('@embroider/addon-shim');
module.exports = addonV1Shim(__dirname);
================================================
FILE: ember-shepherd/babel.config.json
================================================
{
"plugins": [
[
"@babel/plugin-transform-typescript",
{
"allExtensions": true,
"onlyRemoveTypeImports": true,
"allowDeclareFields": true
}
],
"@embroider/addon-dev/template-colocation-plugin",
[
"babel-plugin-ember-template-compilation",
{
"targetFormat": "hbs",
"transforms": []
}
],
[
"module:decorator-transforms",
{ "runtime": { "import": "decorator-transforms/runtime" } }
]
]
}
================================================
FILE: ember-shepherd/eslint.config.mjs
================================================
/**
* Debugging:
* https://eslint.org/docs/latest/use/configure/debug
* ----------------------------------------------------
*
* Print a file's calculated configuration
*
* npx eslint --print-config path/to/file.js
*
* Inspecting the config
*
* npx eslint --inspect-config
*
*/
import babelParser from '@babel/eslint-parser';
import js from '@eslint/js';
import prettier from 'eslint-config-prettier';
import ember from 'eslint-plugin-ember/recommended';
import importPlugin from 'eslint-plugin-import';
import n from 'eslint-plugin-n';
import globals from 'globals';
import ts from 'typescript-eslint';
const parserOptions = {
esm: {
js: {
ecmaFeatures: { modules: true },
ecmaVersion: 'latest',
},
ts: {
projectService: true,
tsconfigRootDir: import.meta.dirname,
},
},
};
export default ts.config(
js.configs.recommended,
ember.configs.base,
ember.configs.gjs,
ember.configs.gts,
prettier,
/**
* Ignores must be in their own object
* https://eslint.org/docs/latest/use/configure/ignore
*/
{
ignores: ['dist/', 'declarations/', 'node_modules/', 'coverage/', '!**/.*'],
},
/**
* https://eslint.org/docs/latest/use/configure/configuration-files#configuring-linter-options
*/
{
linterOptions: {
reportUnusedDisableDirectives: 'error',
},
},
{
files: ['**/*.js'],
languageOptions: {
parser: babelParser,
},
},
{
files: ['**/*.{js,gjs}'],
languageOptions: {
parserOptions: parserOptions.esm.js,
globals: {
...globals.browser,
},
},
},
{
files: ['**/*.{ts,gts}'],
languageOptions: {
parser: ember.parser,
parserOptions: parserOptions.esm.ts,
},
extends: [...ts.configs.recommendedTypeChecked, ember.configs.gts],
},
{
files: ['src/**/*'],
plugins: {
import: importPlugin,
},
rules: {
// require relative imports use full extensions
'import/extensions': ['error', 'always', { ignorePackages: true }],
},
},
/**
* CJS node files
*/
{
files: [
'**/*.cjs',
'.prettierrc.js',
'.stylelintrc.js',
'.template-lintrc.js',
'addon-main.cjs',
],
plugins: {
n,
},
languageOptions: {
sourceType: 'script',
ecmaVersion: 'latest',
globals: {
...globals.node,
},
},
},
/**
* ESM node files
*/
{
files: ['**/*.mjs'],
plugins: {
n,
},
languageOptions: {
sourceType: 'module',
ecmaVersion: 'latest',
parserOptions: parserOptions.esm.js,
globals: {
...globals.node,
},
},
},
);
================================================
FILE: ember-shepherd/package.json
================================================
{
"name": "ember-shepherd",
"version": "18.0.0",
"description": "An Ember wrapper for the site tour library Shepherd.",
"keywords": [
"ember-addon",
"tour",
"shepherd",
"user journey",
"site tour"
],
"repository": "https://github.com/RobbieTheWagner/ember-shepherd",
"license": "AGPL-3.0",
"author": {
"name": "Robert Wagner",
"email": "rwwagner90@gmail.com",
"url": "https://github.com/RobbieTheWagner"
},
"exports": {
".": {
"types": "./declarations/index.d.ts",
"default": "./dist/index.js"
},
"./*": {
"types": "./declarations/*.d.ts",
"default": "./dist/*.js"
},
"./addon-main.js": "./addon-main.cjs"
},
"typesVersions": {
"*": {
"*": [
"declarations/*"
]
}
},
"files": [
"addon-main.cjs",
"declarations",
"dist",
"LICENSE.md"
],
"scripts": {
"build": "rollup --config",
"format": "prettier . --cache --write",
"lint": "concurrently \"pnpm:lint:*(!fix)\" --names \"lint:\" --prefixColors auto",
"lint:fix": "concurrently \"pnpm:lint:*:fix\" --names \"fix:\" --prefixColors auto && pnpm run format",
"lint:format": "prettier . --cache --check",
"lint:hbs": "ember-template-lint . --no-error-on-unmatched-pattern",
"lint:hbs:fix": "ember-template-lint . --fix --no-error-on-unmatched-pattern",
"lint:js": "eslint . --cache",
"lint:js:fix": "eslint . --fix",
"lint:types": "glint",
"prepack": "rollup --config",
"start": "rollup --config --watch",
"test": "echo 'A v2 addon does not have tests, run tests in test-app'"
},
"dependencies": {
"@embroider/addon-shim": "^1.10.2",
"@embroider/macros": "^1.19.6",
"decorator-transforms": "^2.3.1",
"shepherd.js": "^15.0.0"
},
"devDependencies": {
"@babel/core": "^7.29.0",
"@babel/eslint-parser": "^7.28.6",
"@babel/plugin-transform-typescript": "^7.28.6",
"@babel/runtime": "^7.28.6",
"@ember/library-tsconfig": "^1.1.3",
"@embroider/addon-dev": "^7.1.6",
"@eslint/js": "^9.39.2",
"@glint/core": "^1.5.2",
"@glint/environment-ember-loose": "^1.5.2",
"@glint/environment-ember-template-imports": "^1.5.2",
"@glint/template": "^1.7.4",
"@rollup/plugin-babel": "^6.1.0",
"@tsconfig/ember": "^3.0.12",
"@typescript-eslint/eslint-plugin": "^8.57.0",
"@typescript-eslint/parser": "^8.54.0",
"babel-plugin-ember-template-compilation": "^2.4.1",
"concurrently": "^9.2.1",
"ember-source": "~5.12.0",
"ember-template-lint": "^6.1.0",
"eslint": "^9.39.2",
"eslint-config-prettier": "^9.1.2",
"eslint-plugin-ember": "^12.7.5",
"eslint-plugin-import": "^2.32.0",
"eslint-plugin-n": "^17.23.2",
"globals": "^15.15.0",
"prettier": "^3.8.1",
"prettier-plugin-ember-template-tag": "^2.1.3",
"rollup": "^4.57.1",
"rollup-plugin-copy": "^3.5.0",
"typescript": "^5.9.3",
"typescript-eslint": "^8.54.0",
"webpack": "^5.105.0"
},
"ember": {
"edition": "octane"
},
"ember-addon": {
"version": 2,
"type": "addon",
"main": "addon-main.cjs",
"app-js": {
"./services/tour.js": "./dist/_app_/services/tour.js"
}
}
}
================================================
FILE: ember-shepherd/rollup.config.mjs
================================================
import { babel } from '@rollup/plugin-babel';
import copy from 'rollup-plugin-copy';
import { Addon } from '@embroider/addon-dev/rollup';
const addon = new Addon({
srcDir: 'src',
destDir: 'dist',
});
export default {
// This provides defaults that work well alongside `publicEntrypoints` below.
// You can augment this if you need to.
output: addon.output(),
plugins: [
// These are the modules that users should be able to import from your
// addon. Anything not listed here may get optimized away.
// By default all your JavaScript modules (**/*.js) will be importable.
// But you are encouraged to tweak this to only cover the modules that make
// up your addon's public API. Also make sure your package.json#exports
// is aligned to the config here.
// See https://github.com/embroider-build/embroider/blob/main/docs/v2-faq.md#how-can-i-define-the-public-exports-of-my-addon
addon.publicEntrypoints(['index.js', '**/*.js']),
// These are the modules that should get reexported into the traditional
// "app" tree. Things in here should also be in publicEntrypoints above, but
// not everything in publicEntrypoints necessarily needs to go here.
addon.appReexports([
'components/**/*.js',
'helpers/**/*.js',
'modifiers/**/*.js',
'services/**/*.js',
]),
// Follow the V2 Addon rules about dependencies. Your code can import from
// `dependencies` and `peerDependencies` as well as standard Ember-provided
// package names.
addon.dependencies(),
// This babel config should *not* apply presets or compile away ES modules.
// It exists only to provide development niceties for you, like automatic
// template colocation.
//
// By default, this will load the actual babel config from the file
// babel.config.json.
babel({
extensions: ['.js', '.gjs', '.ts', '.gts'],
babelHelpers: 'bundled',
}),
// Ensure that standalone .hbs files are properly integrated as Javascript.
addon.hbs(),
// Ensure that .gjs files are properly integrated as Javascript
addon.gjs(),
// Emit .d.ts declaration files
addon.declarations('declarations'),
// addons are allowed to contain imports of .css files, which we want rollup
// to leave alone and keep in the published output.
addon.keepAssets(['**/*.css']),
// Remove leftover build artifacts when starting a new build.
addon.clean(),
// Copy Readme and License into published package
copy({
targets: [
{ src: '../README.md', dest: '.' },
{ src: '../LICENSE.md', dest: '.' },
],
}),
],
};
================================================
FILE: ember-shepherd/src/.gitkeep
================================================
================================================
FILE: ember-shepherd/src/index.ts
================================================
================================================
FILE: ember-shepherd/src/services/tour.ts
================================================
/* eslint-disable ember/no-runloop */
import { isEmpty, isPresent } from '@ember/utils';
import Service from '@ember/service';
import Evented from '@ember/object/evented';
import { registerDestructor } from '@ember/destroyable';
import type Owner from '@ember/owner';
import { bind } from '@ember/runloop';
import { isTesting } from '@embroider/macros';
import { tracked } from '@glimmer/tracking';
import { type StepOptions, type Tour } from 'shepherd.js';
import { type EmberShepherdButton, makeButton } from '../utils/buttons.ts';
import { elementIsHidden } from '../utils/dom.ts';
interface EmberShepherdStepOptions extends Omit<StepOptions, 'buttons'> {
buttons?: Array<EmberShepherdButton>;
}
/**
* Interaction with `ember-shepherd` is done entirely through the Tour service, which you can access from any object using the `service` syntax:
*
* ```js
* import Component from '@glimmer/component';
* import { service } from '@ember/service';
*
* export default class MyCoolComponent extends Component {
*
* @service tour;
*
* // OR
*
* @service('tour') tourService;
* };
* ```
*
* The following configuration options can be `set` on the Tour service to control the way that Shepherd is used. **The only required option is `steps`, which is set via `addSteps`.**
*
* @class Tour
*/
export default class TourService extends Service.extend(Evented) {
declare tourName?: string;
// Configuration Options
/**
* The prefix to add to all the `shepherd-*` class names.
*
* @default undefined
* @property classPrefix
* @type String
*/
@tracked classPrefix?: string;
/**
* `confirmCancel` is a boolean flag, when set to `true` it will pop up a native browser
* confirm window on cancel, to ensure you want to cancel.
*
* @default false
* @property confirmCancel
* @type Boolean
*/
@tracked confirmCancel = false;
/**
* `confirmCancelMessage` is a string to display in the confirm dialog when `confirmCancel`
* is set to true.
*
* @default undefined
* @property confirmCancelMessage
* @type String
*/
@tracked confirmCancelMessage?: string;
/**
* `defaultStepOptions` is used to set the options that will be applied to each step by default.
* You can pass in any of the options that you can with Shepherd.
*
* **⚠️ You must set `defaultStepOptions` *BEFORE* calling `addSteps` to set the steps.**
*
* It will be an object of a form something like:
*
* ```js
* this.tour.set('defaultStepOptions', {
* classes: 'custom-class-name-1 custom-class-name-2',
* scrollTo: true,
* cancelIcon: {
* enabled: true
* },
* });
* ```
*
* > **default value:** `{}`
*
* @default {}
* @property defaultStepOptions
* @type StepOptions
*/
@tracked defaultStepOptions: StepOptions = {};
/**
* @default undefined
* @property errorTitle
* @type String
*/
@tracked errorTitle?: string;
/**
* Exiting the tour with the escape key will be enabled unless this is explicitly set to false.
*
* @default undefined
* @property exitOnEsc
* @type Boolean
*/
@tracked exitOnEsc?: boolean;
/**
* @default false
* @property isActive
* @type Boolean
*/
@tracked isActive = false;
/**
* Navigating the tour via left and right arrow keys will be enabled unless this is explicitly set to false.
*
* @default undefined
* @property keyboardNavigation
* @type Boolean
*/
@tracked keyboardNavigation?: boolean;
/**
* @default undefined
* @property messageForUser
* @type String
*/
@tracked messageForUser?: string;
/**
* `modal` is a boolean, that should be set to true, if you would like the rest of the screen, other than the current element, greyed out, and the current element highlighted. If you do not need modal functionality, you can remove this option or set it to false.
*
* > **default value:** `false`
*
* @default false
* @property modal
* @type Boolean
*/
@tracked modal = false;
/**
* An optional container element for the modal. If not set, the modal will be appended to `document.body`.
* @default undefined
* @property modalContainer
* @type HTMLElement
*/
@tracked modalContainer?: HTMLElement;
/**
* `requiredElements` is an array of objects that indicate DOM elements that are **REQUIRED** by your tour and must
* exist and be visible for the tour to start. If any elements are not present, it will keep the tour from starting.
*
* You can also specify a message, which will tell the user what they need to do to make the tour work.
*
* **⚠️ You must set `requiredElements` *BEFORE* calling `addSteps` to set the steps.**
*
* _Example_
* ```js
* this.tour.requiredElements = [
* {
* selector: '.search-result-element',
* message: 'No search results found. Please execute another search, and try to start the tour again.',
* title: 'No results'
* },
* {
* selector: '.username-element',
* message: 'User not logged in, please log in to start this tour.',
* title: 'Please login'
* },
* ];
* ```
* > **default value:** `[]`
*
* @default []
* @property requiredElements
* @type Array
*/
@tracked requiredElements = [];
/**
* An optional container element for the steps. If not set, the steps will be appended to `document.body`.
* @default undefined
* @property stepsContainer
* @type HTMLElement
*/
@tracked stepsContainer?: HTMLElement;
/**
* A reference to the Shepherd Tour instance.
*
* @property tourObject
* @type Tour
*/
@tracked declare tourObject?: Tour;
constructor(owner: Owner) {
super(owner);
// eslint-disable-next-line @typescript-eslint/no-misused-promises
registerDestructor(this, () => this.tourObject?.cancel());
}
/**
* Take a set of steps, create a tour object based on the current configuration and load the shepherd.js dependency.
* This method returns a promise which resolves when the shepherd.js dependency has been loaded and shepherd is ready to use.
*
* You must pass an array of steps to `addSteps`, something like this:
*
* ```js
* this.tour.addSteps([
* {
* attachTo: {
* element:'.first-element',
* on: 'bottom'
* },
* beforeShowPromise: function() {
* return new Promise(function(resolve) {
* Ember.run.scheduleOnce('afterRender', this, function() {
* window.scrollTo(0, 0);
* this.get('documents.firstObject').set('isSelected', true);
* resolve();
* });
* });
* },
* buttons: [
* {
* classes: 'shepherd-button-secondary',
* text: 'Exit',
* type: 'cancel'
* },
* {
* classes: 'shepherd-button-primary',
* text: 'Back',
* type: 'back'
* },
* {
* classes: 'shepherd-button-primary',
* text: 'Next',
* type: 'next'
* }
* ],
* cancelIcon: {
* enabled: true
* },
* classes: 'custom-class-name-1 custom-class-name-2',
* highlightClass: 'highlight',
* id: 'intro',
* scrollTo: false,
* title: 'Welcome to Ember-Shepherd!',
* text: 'Ember-Shepherd is a JavaScript library for guiding users through your Ember app.',
* when: {
* show: () => {
* console.log('show step');
* },
* hide: () => {
* console.log('hide step');
* }
* }
* },
* ...
* ]);
* ```
*
* @method addSteps
* @param {array} steps An array of steps
* @returns {Promise} Promise that resolves when everything has been set up and shepherd is ready to use
* @public
*/
addSteps(steps: Array<EmberShepherdStepOptions>) {
return this._initialize().then(() => {
const tour = this.tourObject as Tour;
// Return nothing if there are no steps
if (isEmpty(steps)) {
return;
}
/* istanbul ignore next: also can't test this due to things attached to root blowing up tests */
if (!this._requiredElementsPresent()) {
tour.addStep({
buttons: [
{
text: 'Exit',
// eslint-disable-next-line @typescript-eslint/no-misused-promises, @typescript-eslint/unbound-method
action: tour.cancel,
},
],
id: 'error',
title: this.errorTitle,
text: this.messageForUser,
});
return;
}
steps.forEach((step) => {
if (step.buttons) {
step.buttons = step.buttons.map(makeButton.bind(this), this);
}
tour.addStep(step);
});
});
}
/**
* Get the tour object and call back
*
* @method back
* @public
*/
back() {
this.tourObject?.back();
// @ts-expect-error TODO: refactor away from Evented mixin
// eslint-disable-next-line @typescript-eslint/no-unsafe-call
this.trigger('back');
}
/**
* Cancel the tour
*
* @method cancel
* @public
*/
async cancel() {
await this.tourObject?.cancel();
}
/**
* Complete the tour
*
* @method complete
* @public
*/
complete() {
this.tourObject?.complete();
}
/**
* Hides the current step
*
* @method hide
* @public
*/
hide() {
this.tourObject?.hide();
}
/**
* Advance the tour to the next step and trigger next
*
* @method next
* @public
*/
next() {
this.tourObject?.next();
// @ts-expect-error TODO: refactor away from Evented mixin
// eslint-disable-next-line @typescript-eslint/no-unsafe-call
this.trigger('next');
}
/**
* Show a specific step, by passing its id
*
* @param {string} [id] The id of the step you want to show
* @method show
* @public
*/
show(id: string) {
this.tourObject?.show(id);
}
/**
* Start the tour. The Promise from addSteps() must be in a resolved state prior to starting the tour!
*
* @method start
* @public
*/
async start() {
const tourObject = this.tourObject;
if (tourObject == undefined) {
throw new Error(
'the Promise from addSteps must be in a resolved state before the tour can be started',
);
}
this.isActive = true;
await tourObject.start();
}
/**
* When the tour starts, setup the step event listeners
*
* @method _onTourStart
* @private
*/
_onTourStart() {
// @ts-expect-error TODO: refactor away from Evented mixin
// eslint-disable-next-line @typescript-eslint/no-unsafe-call
this.trigger('start');
}
/**
* This function is called when a tour is completed or cancelled to initiate cleanup.
*
* @method _onTourFinish
* @param {string} [completeOrCancel] 'complete' or 'cancel'
* @private
*/
_onTourFinish(completeOrCancel: 'complete' | 'cancel') {
if (!this.isDestroyed) {
this.isActive = false;
}
// @ts-expect-error TODO: refactor away from Evented mixin
// eslint-disable-next-line @typescript-eslint/no-unsafe-call
this.trigger(completeOrCancel);
}
/**
* Initializes the tour, creates a new Shepherd.Tour. sets options, and binds events
*
* @method _initialize
* @private
*/
_initialize() {
const {
classPrefix,
confirmCancel,
confirmCancelMessage,
defaultStepOptions,
exitOnEsc,
keyboardNavigation,
modal,
modalContainer,
stepsContainer,
tourName,
} = this;
// Ensure `floatingUIOptions` exists on `defaultStepOptions`
defaultStepOptions.floatingUIOptions =
defaultStepOptions.floatingUIOptions || {};
return import('shepherd.js').then((module) => {
const Shepherd = module.default;
const tourObject = new Shepherd.Tour({
classPrefix,
confirmCancel,
confirmCancelMessage,
defaultStepOptions,
exitOnEsc,
keyboardNavigation,
modalContainer:
modalContainer ??
(isTesting()
? (document.querySelector('#ember-testing') as HTMLElement)
: document.body),
stepsContainer:
stepsContainer ??
(isTesting()
? (document.querySelector('#ember-testing') as HTMLElement)
: document.body),
tourName,
useModalOverlay: modal,
});
tourObject.on('start', bind(this, '_onTourStart'));
tourObject.on('complete', bind(this, '_onTourFinish', 'complete'));
tourObject.on('cancel', bind(this, '_onTourFinish', 'cancel'));
this.tourObject = tourObject;
});
}
/**
* Observes the array of requiredElements, which are the elements that must be present at the start of the tour,
* and determines if they exist, and are visible, if either is false, it will stop the tour from executing.
*
* @method _requiredElementsPresent
* @private
*/
_requiredElementsPresent() {
let allElementsPresent = true;
const requiredElements = this.requiredElements;
if (isPresent(requiredElements)) {
/* istanbul ignore next: also can't test this due to things attached to root blowing up tests */
requiredElements.forEach(
(element: { message: string; selector: string; title: string }) => {
const selectedElement = document.querySelector(element.selector);
if (
allElementsPresent &&
(!selectedElement ||
elementIsHidden(selectedElement as HTMLElement))
) {
allElementsPresent = false;
this.errorTitle = element.title;
this.messageForUser = element.message;
}
},
);
}
return allElementsPresent;
}
}
================================================
FILE: ember-shepherd/src/template-registry.ts
================================================
// Easily allow apps, which are not yet using strict mode templates, to consume your Glint types, by importing this file.
// Add all your components, helpers and modifiers to the template registry here, so apps don't have to do this.
// See https://typed-ember.gitbook.io/glint/environments/ember/authoring-addons
// import type MyComponent from './components/my-component';
// Uncomment this once entries have been added! 👇
// export default interface Registry {
// MyComponent: typeof MyComponent
// }
================================================
FILE: ember-shepherd/src/unpublished-development-types/index.d.ts
================================================
// Add any types here that you need for local development only.
// These will *not* be published as part of your addon, so be careful that your published code does not rely on them!
import 'ember-source/types/stable';
import 'ember-source/types/preview';
================================================
FILE: ember-shepherd/src/utils/buttons.ts
================================================
/* eslint-disable ember/no-runloop */
import { bind } from '@ember/runloop';
import { assert } from '@ember/debug';
import { type StepOptionsButton } from 'shepherd.js';
import type TourService from '../services/tour';
export type EmberShepherdButton = StepOptionsButton & {
type?: 'back' | 'cancel' | 'next';
};
/**
* Creates a button of the specified type, with the given classes and text
*
* @function makeButton
* @param {object} [button] Description here
* @param {string} [button.type] The type of button cancel, back, or next
* @param {classes} [button.classes] Classes to apply to the button
* @param {string} [button.text] The text for the button
* @param {action} [button.action] The action to call
* @private
* @return {{action: *, classes: *, text: *}} Description here
*/
export function makeButton(
this: TourService,
button: EmberShepherdButton,
): EmberShepherdButton {
const { classes, disabled, label, secondary, text, type } = button;
const builtInButtonTypes = ['back', 'cancel', 'next'];
if (!type) {
return button;
}
assert(
`'type' property must be one of 'back', 'cancel', or 'next'`,
builtInButtonTypes.includes(type),
);
const action = bind(this, function () {
void this[type]();
});
return {
action,
classes,
disabled,
label,
secondary,
text,
type,
};
}
================================================
FILE: ember-shepherd/src/utils/dom.ts
================================================
/**
* Helper method to check if element is hidden, since we cannot use :visible without jQuery
*
* @function elementIsHidden
* @param {HTMLElement} element The element to check for visibility
* @private
* @return {boolean} true if element is hidden
*/
export function elementIsHidden(element: HTMLElement) {
return element.offsetWidth === 0 && element.offsetHeight === 0;
}
================================================
FILE: ember-shepherd/tsconfig.json
================================================
{
"extends": "@ember/library-tsconfig",
"include": ["src/**/*", "unpublished-development-types/**/*"],
"glint": {
"environment": ["ember-loose", "ember-template-imports"]
},
"compilerOptions": {
"allowJs": true,
"declarationDir": "declarations",
/**
https://www.typescriptlang.org/tsconfig#rootDir
"Default: The longest common path of all non-declaration input files."
Because we want our declarations' structure to match our rollup output,
we need this "rootDir" to match the "srcDir" in the rollup.config.mjs.
This way, we can have simpler `package.json#exports` that matches
imports to files on disk
*/
"rootDir": "./src",
"types": ["ember-source/types"]
}
}
================================================
FILE: ember-shepherd/unpublished-development-types/index.d.ts
================================================
// Add any types here that you need for local development only.
// These will *not* be published as part of your addon, so be careful that your published code does not rely on them!
import '@glint/environment-ember-loose';
import '@glint/environment-ember-template-imports';
// Uncomment if you need to support consuming projects in loose mode
//
// declare module '@glint/environment-ember-loose/registry' {
// export default interface Registry {
// // Add any registry entries from other addons here that your addon itself uses (in non-strict mode templates)
// // See https://typed-ember.gitbook.io/glint/using-glint/ember/using-addons
// }
// }
================================================
FILE: package.json
================================================
{
"version": "17.3.1",
"private": true,
"repository": "https://github.com/RobbieTheWagner/ember-shepherd",
"license": "AGPL-3.0",
"author": {
"name": "Robert Wagner",
"email": "rwwagner90@gmail.com",
"url": "https://github.com/RobbieTheWagner"
},
"scripts": {
"build": "pnpm --filter ember-shepherd build",
"lint": "pnpm --filter '*' lint",
"lint:fix": "pnpm --filter '*' lint:fix",
"prepare": "pnpm build",
"start": "concurrently 'pnpm:start:*' --restart-after 5000 --prefixColors auto",
"start:addon": "pnpm --filter ember-shepherd start --no-watch.clearScreen",
"start:test-app": "pnpm --filter test-app start",
"test": "pnpm --filter '*' test",
"test:ember": "pnpm --filter '*' test:ember"
},
"devDependencies": {
"@glint/core": "^1.5.2",
"concurrently": "^9.2.1",
"prettier": "^3.8.1",
"prettier-plugin-ember-template-tag": "^2.1.3",
"release-plan": "^0.17.4"
},
"engines": {
"node": ">= 20"
}
}
================================================
FILE: pnpm-workspace.yaml
================================================
packages:
- ember-shepherd
- test-app
onlyBuiltDependencies:
- '@parcel/watcher'
- core-js
- ember-modal-dialog
================================================
FILE: test-app/.editorconfig
================================================
# EditorConfig helps developers define and maintain consistent
# coding styles between different editors and IDEs
# editorconfig.org
root = true
[*]
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
indent_style = space
indent_size = 2
[*.hbs]
insert_final_newline = false
[*.{diff,md}]
trim_trailing_whitespace = false
================================================
FILE: test-app/.ember-cli
================================================
{
/**
Setting `isTypeScriptProject` to true will force the blueprint generators to generate TypeScript
rather than JavaScript by default, when a TypeScript version of a given blueprint is available.
*/
"isTypeScriptProject": true,
/**
Setting `componentAuthoringFormat` to "strict" will force the blueprint generators to generate GJS
or GTS files for the component and the component rendering test. "strict" is the default.
*/
"componentAuthoringFormat": "strict",
/**
Setting `routeAuthoringFormat` to "strict" will force the blueprint generators to generate GJS
or GTS templates for routes. "strict" is the default
*/
"routeAuthoringFormat": "strict"
}
================================================
FILE: test-app/.gitignore
================================================
# compiled output
/dist/
/declarations/
# dependencies
/node_modules/
# misc
/.env*
/.pnp*
/.eslintcache
/coverage/
/npm-debug.log*
/testem.log
/yarn-error.log
# broccoli-debug
/DEBUG/
# addon-docs
deploy-test-app/
tmp/
================================================
FILE: test-app/.prettierignore
================================================
# unconventional js
/blueprints/*/files/
# compiled output
/dist/
# misc
/coverage/
!.*
.*/
/pnpm-lock.yaml
ember-cli-update.json
*.html
================================================
FILE: test-app/.prettierrc.js
================================================
'use strict';
module.exports = {
plugins: ['prettier-plugin-ember-template-tag'],
overrides: [
{
files: '*.{js,gjs,ts,gts,mjs,mts,cjs,cts}',
options: {
singleQuote: true,
templateSingleQuote: false,
},
},
],
};
================================================
FILE: test-app/.stylelintignore
================================================
# unconventional files
/blueprints/*/files/
# compiled output
/dist/
================================================
FILE: test-app/.stylelintrc.js
================================================
'use strict';
module.exports = {
extends: ['stylelint-config-standard'],
rules: {
'color-hex-length': null,
'font-family-no-missing-generic-family-keyword': null,
},
};
================================================
FILE: test-app/.template-lintrc.js
================================================
'use strict';
module.exports = {
extends: 'recommended',
};
================================================
FILE: test-app/.watchmanconfig
================================================
{
"ignore_dirs": ["dist"]
}
================================================
FILE: test-app/README.md
================================================
# test-app
This README outlines the details of collaborating on this Ember application.
A short introduction of this app could easily go here.
## Prerequisites
You will need the following things properly installed on your computer.
- [Git](https://git-scm.com/)
- [Node.js](https://nodejs.org/) (with npm)
- [Ember CLI](https://cli.emberjs.com/release/)
- [Google Chrome](https://google.com/chrome/)
## Installation
- `git clone <repository-url>` this repository
- `cd test-app`
- `npm install`
## Running / Development
- `npm run start`
- Visit your app at [http://localhost:4200](http://localhost:4200).
- Visit your tests at [http://localhost:4200/tests](http://localhost:4200/tests).
### Code Generators
Make use of the many generators for code, try `ember help generate` for more details
### Running Tests
- `npm run test`
- `npm run test:ember -- --server`
### Linting
- `npm run lint`
- `npm run lint:fix`
### Building
- `npm exec ember build` (development)
- `npm run build` (production)
### Deploying
Specify what it takes to deploy your app.
## Further Reading / Useful Links
- [ember.js](https://emberjs.com/)
- [ember-cli](https://cli.emberjs.com/release/)
- Development Browser Extensions
- [ember inspector for chrome](https://chrome.google.com/webstore/detail/ember-inspector/bmdblncegkenkacieihfhpjfppoconhi)
- [ember inspector for firefox](https://addons.mozilla.org/en-US/firefox/addon/ember-inspector/)
================================================
FILE: test-app/app/app.ts
================================================
import '@warp-drive/ember/install';
import Application from '@ember/application';
import Resolver from 'ember-resolver';
import loadInitializers from 'ember-load-initializers';
import config from 'test-app/config/environment';
import { importSync, isDevelopingApp, macroCondition } from '@embroider/macros';
if (macroCondition(isDevelopingApp())) {
importSync('./deprecation-workflow');
}
export default class App extends Application {
modulePrefix = config.modulePrefix;
podModulePrefix = config.podModulePrefix;
Resolver = Resolver;
}
loadInitializers(App, config.modulePrefix);
================================================
FILE: test-app/app/components/.gitkeep
================================================
================================================
FILE: test-app/app/config/environment.d.ts
================================================
/**
* Type declarations for
* import config from 'test-app/config/environment'
*/
declare const config: {
environment: string;
modulePrefix: string;
podModulePrefix: string;
locationType: 'history' | 'hash' | 'none';
rootURL: string;
APP: Record<string, unknown>;
};
export default config;
================================================
FILE: test-app/app/controllers/.gitkeep
================================================
================================================
FILE: test-app/app/controllers/docs/demo.js
================================================
import Controller from '@ember/controller';
import { action } from '@ember/object';
import { inject as service } from '@ember/service';
import { steps as defaultSteps } from '../../data';
export default class DocsDemoController extends Controller {
@service tour;
usage = `//Inject the service: tour: service()
let tour = this.tour;
tour.set('defaultStepOptions', shepherdStepDefaults);
tour.set('disableScroll', true);
tour.set('modal', true);
tour.set('requiredElements', requiredElements);
tour.addSteps(steps);
// Methods to control the tour
tour.start();
tour.next();
tour.back();
tour.cancel();`;
@action
toggleHelpModal() {
this.tour.set('modal', true);
this.tour.addSteps(defaultSteps);
this.tour.start();
}
@action
toggleHelpNonmodal() {
this.tour.set('modal', false);
this.tour.addSteps(defaultSteps);
this.tour.start();
}
}
================================================
FILE: test-app/app/data.js
================================================
export const builtInButtons = {
cancel: {
classes: 'cancel-button',
secondary: true,
text: 'Exit',
type: 'cancel',
},
next: {
classes: 'next-button',
text: 'Next',
type: 'next',
},
back: {
classes: 'back-button',
text: 'Back',
type: 'back',
},
};
export const defaultStepOptions = {
classes: 'shepherd-theme-arrows custom-default-class',
scrollTo: true,
cancelIcon: {
enabled: true,
},
};
export const steps = [
{
attachTo: {
element: '.first-element',
on: 'bottom',
},
buttons: [builtInButtons.cancel, builtInButtons.next],
classes: 'custom-class-name-1 custom-class-name-2',
id: 'intro',
title: 'Welcome to Ember Shepherd!',
text: `
<p>
Ember Shepherd is a JavaScript library for guiding users through your Ember app.
It is an Ember addon that wraps <a href="https://github.com/shipshapecode/shepherd">Shepherd</a>
and extends its functionality. Shepherd uses <a href="https://popper.js.org/">Popper.js</a>,
another open source library, to render dialogs for each tour "step".
</p>
<p>
Popper makes sure your steps never end up off screen or cropped by an
overflow. Try resizing your browser to see what we mean.
</p>`,
},
{
attachTo: {
element: '.install-element .shiki-code-block',
on: 'bottom',
},
buttons: [builtInButtons.cancel, builtInButtons.back, builtInButtons.next],
classes: 'custom-class-name-1 custom-class-name-2',
id: 'installation',
title: 'Installation',
text: 'Installation is simple, if you are using Ember-CLI, just install like any other addon.',
},
{
attachTo: {
element: '.usage-element .shiki-code-block',
on: 'bottom',
},
buttons: [builtInButtons.cancel, builtInButtons.back, builtInButtons.next],
classes: 'custom-class-name-1 custom-class-name-2',
id: 'usage',
title: 'Usage',
text: 'To use the tour service, simply inject it into your application and use it like this example.',
},
{
attachTo: {
element: '.modal-element',
on: 'top',
},
buttons: [builtInButtons.cancel, builtInButtons.back, builtInButtons.next],
classes: 'custom-class-name-1 custom-class-name-2',
id: 'modal',
text: `
<p>
We implemented true modal functionality by disabling clicking of the rest of the page.
</p>
<p>
If you would like to enable modal, simply do this.tour.set('modal', true).
</p>`,
},
{
attachTo: {
element: '.built-in-buttons-element',
on: 'top',
},
buttons: [builtInButtons.cancel, builtInButtons.back, builtInButtons.next],
classes: 'custom-class-name-1 custom-class-name-2',
id: 'buttons',
text: `For the common button types ("next", "back", "cancel", etc.), we implemented Ember actions
that perform these actions on your tour automatically. To use them, simply include
in the buttons array in each step.`,
},
{
attachTo: {
element: '.disable-scroll-element',
on: 'top',
},
buttons: [builtInButtons.cancel, builtInButtons.back, builtInButtons.next],
classes: 'custom-class-name-1 custom-class-name-2',
id: 'disableScroll',
text: `
<p>
When navigating the user through a tour, you may want to disable scrolling, so they
cannot mess up your carefully planned out, amazing tour. This is now easily achieved
with this.tour.set('disableScroll', true).
</p>
<p>
Try scrolling right now, then exit the tour and see that you can again!
</p>`,
},
{
buttons: [builtInButtons.cancel, builtInButtons.back],
id: 'noAttachTo',
title: 'Centered Modals',
classes: 'custom-class-name-1 custom-class-name-2',
text: 'If no attachTo is specified, the modal will appear in the center of the screen, as per the Shepherd docs.',
},
];
================================================
FILE: test-app/app/deprecation-workflow.ts
================================================
import setupDeprecationWorkflow from 'ember-cli-deprecation-workflow';
/**
* Docs: https://github.com/ember-cli/ember-cli-deprecation-workflow
*/
setupDeprecationWorkflow({
/**
false by default, but if a developer / team wants to be more aggressive about being proactive with
handling their deprecations, this should be set to "true"
*/
throwOnUnhandled: false,
workflow: [
/* ... handlers ... */
/* to generate this list, run your app for a while (or run the test suite),
* and then run in the browser console:
*
* deprecationWorkflow.flushDeprecations()
*
* And copy the handlers here
*/
/* example: */
/* { handler: 'silence', matchId: 'template-action' }, */
],
});
================================================
FILE: test-app/app/helpers/.gitkeep
================================================
================================================
FILE: test-app/app/index.html
================================================
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Ember Shepherd</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
{{content-for "head"}}
<link integrity="" rel="stylesheet" href="{{rootURL}}assets/vendor.css">
<link integrity="" rel="stylesheet" href="{{rootURL}}assets/test-app.css">
{{content-for "head-footer"}}
</head>
<body>
{{content-for "body"}}
<script src="{{rootURL}}assets/vendor.js"></script>
<script src="{{rootURL}}assets/test-app.js"></script>
{{content-for "body-footer"}}
</body>
</html>
================================================
FILE: test-app/app/models/.gitkeep
================================================
================================================
FILE: test-app/app/router.js
================================================
import AddonDocsRouter, { docsRoute } from 'ember-cli-addon-docs/router';
import config from 'test-app/config/environment';
const Router = AddonDocsRouter.extend({
location: config.locationType,
rootURL: config.rootURL,
});
Router.map(function () {
docsRoute(this, function () {
this.route('demo');
this.route('faq');
this.route('style-variables');
this.route('usage');
this.route('not-found', { path: '/*path' });
});
});
export default Router;
================================================
FILE: test-app/app/routes/.gitkeep
================================================
================================================
FILE: test-app/app/routes/docs/demo.js
================================================
import Route from '@ember/routing/route';
import config from '../../config/environment';
import { inject as service } from '@ember/service';
import { scheduleOnce } from '@ember/runloop';
import { steps as defaultSteps, defaultStepOptions } from '../../data';
export default class DocsDemoRoute extends Route {
@service tour;
disableScroll = false;
async beforeModel() {
const tour = this.tour;
tour.set('defaultStepOptions', defaultStepOptions);
tour.set('disableScroll', this.disableScroll);
tour.set('modal', true);
tour.set('confirmCancel', false);
await tour.addSteps(defaultSteps);
tour.on('cancel', () => {
console.log('cancel');
});
}
model() {
return {
links: [
{
href: 'https://github.com/RobbieTheWagner/ember-shepherd',
text: 'Docs',
type: 'href',
},
{
href: 'https://github.com/RobbieTheWagner/ember-shepherd',
text: 'GitHub',
type: 'href',
},
{
href: 'https://shipshape.io',
text: 'Ship Shape',
type: 'href',
},
],
};
}
activate() {
if (config.environment !== 'test') {
// eslint-disable-next-line ember/no-runloop
scheduleOnce('afterRender', this, this._startTour);
}
}
_startTour() {
this.tour.start();
}
}
================================================
FILE: test-app/app/styles/app.css
================================================
@import url("https://cdn.jsdelivr.net/npm/shepherd.js@14.3.0/dist/css/shepherd.min.css");
@import url("./fonts.css");
@import url("./shepherd-theme.css");
html,
body {
-webkit-font-smoothing: antialiased;
-moz-osx-font-smoothing: grayscale;
}
body {
height: 100%;
margin: 0;
}
a,
button {
transition: 0.25s ease-in-out;
}
.button {
cursor: pointer;
display: inline-block;
text-decoration: none;
text-transform: uppercase;
transition: 0.25s ease-in-out;
}
.button:hover {
background: #f3f5f5;
transform: translateX(10px) translateY(-10px);
}
.demo-page .panel {
background-color: rgb(248 250 252);
border-color: #d8d8d8;
border-style: solid;
border-width: 1px;
color: black;
font-size: 0.75em;
margin-bottom: 1.25rem;
padding: 1.25rem;
text-align: center;
}
.demo-page .button.dark {
background: white;
color: black;
}
@media (width <= 568px) {
.demo-page .button {
display: block;
margin: 1em auto 0;
}
}
.demo-page .page-title {
color: black;
font-size: 50pt;
.ember-title {
font-family: Pacifico;
}
}
@media only screen and (width >= 40.0625em) {
.demo-page h1,
.demo-page h2,
.demo-page h3,
.demo-page h4,
.demo-page h5,
.demo-page h6 {
line-height: 1.4;
}
.demo-page h1 {
font-size: 2.75rem;
}
.demo-page h2 {
font-size: 2.3125rem;
}
.demo-page h3 {
font-size: 1.6875rem;
}
.demo-page h4 {
font-size: 1.4375rem;
}
.demo-page h5 {
font-size: 1.125rem;
}
.demo-page h6 {
font-size: 1rem;
}
}
:root {
--brand-primary: #ef898b;
}
.hero {
padding: 0 2rem;
}
================================================
FILE: test-app/app/styles/fonts.css
================================================
@import url("https://fonts.googleapis.com/css?family=Pacifico");
@font-face {
font-family: "GT Pressura";
src:
url("/fonts/GTPressura-Bold.woff2") format("woff2"),
url("/fonts/GTPressura-Bold.woff") format("woff");
font-weight: bold;
font-style: normal;
}
@font-face {
font-family: "Founders Grotesk";
src:
url("/fonts/FoundersGrotesk-Regular.woff2") format("woff2"),
url("/fonts/FoundersGrotesk-Regular.woff") format("woff");
font-weight: normal;
font-style: normal;
}
================================================
FILE: test-app/app/styles/shepherd-theme.css
================================================
.shepherd-logo {
height: auto;
width: 217px;
}
.shepherd-logo .lines,
.shepherd-logo .open-eye,
.shepherd-logo .wink {
transition:
visibility 0s,
opacity 0.25s ease-in-out;
}
.shepherd-logo .open-eye {
opacity: 1;
visibility: visible;
}
.shepherd-logo .lines,
.shepherd-logo .wink {
opacity: 0;
visibility: hidden;
}
.shepherd-logo:hover .lines,
.shepherd-logo:hover .wink {
opacity: 1;
visibility: visible;
}
.shepherd-logo:hover .open-eye {
opacity: 0;
visibility: hidden;
}
.footer-icon path {
fill: #16202d;
transition: 0.25s ease-in-out;
}
.footer-icon:hover path {
fill: #959fac;
}
.footer-logo {
left: 50%;
transform: translateX(-50%) translateY(-50%);
}
.hero-outer .hero-followup {
padding-top: 20px;
}
pre {
border: 1px solid rgb(0 0 0 / 15%);
line-height: 1.4em;
}
.shepherd-button {
background: #ffffff;
border-top: solid 4px #16202d;
border-radius: 0;
color: #16202d;
display: flex;
flex-grow: 1;
font-family: "GT Pressura", sans-serif;
font-size: 1rem;
justify-content: center;
margin: 0;
padding: 1rem;
text-align: center;
text-transform: uppercase;
}
.shepherd-button:hover {
background: #16202d;
color: #ffffff;
}
.shepherd-button.shepherd-button-secondary {
background: #cad5d5;
}
.shepherd-button.shepherd-button-secondary:hover {
color: #cad5d5;
background: #16202d;
}
.shepherd-cancel-icon {
font-family: "GT Pressura", sans-serif;
}
.shepherd-element {
border: solid 4px #16202d;
padding: 0;
}
.shepherd-element,
.shepherd-header,
.shepherd-footer {
border-radius: 0;
}
.shepherd-element .shepherd-arrow {
border-width: 0;
height: auto;
width: auto;
}
.shepherd-arrow::before {
display: none;
}
.shepherd-element .shepherd-arrow::after {
content: url("/img/arrow.svg");
display: inline-block;
}
.shepherd-element[data-popper-placement^="top"] .shepherd-arrow,
.shepherd-element.shepherd-pinned-top .shepherd-arrow {
bottom: -35px;
}
.shepherd-element[data-popper-placement^="top"] .shepherd-arrow::after,
.shepherd-element.shepherd-pinned-top .shepherd-arrow::after {
transform: rotate(270deg);
}
.shepherd-element[data-popper-placement^="bottom"] .shepherd-arrow {
top: -35px;
}
.shepherd-element[data-popper-placement^="bottom"] .shepherd-arrow::after {
transform: rotate(90deg);
}
.shepherd-element[data-popper-placement^="left"] .shepherd-arrow,
.shepherd-element.shepherd-pinned-left .shepherd-arrow {
right: -35px;
}
.shepherd-element[data-popper-placement^="left"] .shepherd-arrow::after,
.shepherd-element.shepherd-pinned-left .shepherd-arrow::after {
transform: rotate(180deg);
}
.shepherd-element[data-popper-placement^="right"] .shepherd-arrow,
.shepherd-element.shepherd-pinned-right .shepherd-arrow {
left: -35px;
}
.shepherd-footer {
padding: 0;
}
.shepherd-footer button:not(:last-of-type) {
border-right: solid 4px #16202d;
}
.shepherd-has-title .shepherd-content .shepherd-cancel-icon {
margin-top: -7px;
}
.shepherd-has-title .shepherd-content .shepherd-header {
background: transparent;
font-family: "GT Pressura", sans-serif;
padding-bottom: 0;
padding-left: 2rem;
}
.shepherd-has-title .shepherd-content .shepherd-header .shepherd-title {
font-size: 1.2rem;
text-transform: uppercase;
}
.shepherd-text {
font-size: 1.2rem;
padding: 2rem;
}
.shepherd-text a,
.shepherd-text a:visited,
.shepherd-text a:active {
border-bottom: 1px dotted;
border-bottom-color: rgb(0 0 0 / 75%);
color: rgb(0 0 0 / 75%);
text-decoration: none;
}
.shepherd-text a:hover,
.shepherd-text a:visited:hover,
.shepherd-text a:active:hover {
border-bottom-style: solid;
}
================================================
FILE: test-app/app/templates/application.hbs
================================================
<div class="ember-view">
<DocsHeader />
{{outlet}}
<DocsKeyboardShortcuts />
</div>
================================================
FILE: test-app/app/templates/docs/demo.hbs
================================================
{{! template-lint-disable }}
<div class="demo-page">
<div class="docs-w-full">
<div class="docs-flex docs-justify-center">
<h1 class="page-title"><span class="ember-title">ember</span>
Shepherd
</h1>
</div>
<div class="docs-flex docs-justify-center docs-my-4">
<h4 class="first-element">Guide your users through a tour of your app.</h4>
</div>
<div class="docs-flex docs-justify-center docs-my-2">
<h5>Installation</h5>
</div>
<div class="docs-flex docs-justify-center docs-mb-8 install-element">
<CodeBlock @code="ember install ember-shepherd" />
</div>
<div class="docs-flex docs-justify-center docs-my-2">
<h5>Usage</h5>
</div>
<div class="docs-flex docs-justify-center docs-mb-8 usage-element">
<CodeBlock @code={{this.usage}} @language="javascript" />
</div>
<div class="docs-flex docs-justify-center docs-my-2">
<h5>Additional Features</h5>
</div>
<div class="docs-flex docs-flex-wrap">
<div
class="panel modal-element docs-flex docs-justify-center docs-w-full lg:docs-w-1/3"
>
Modal
</div>
<div
class="panel built-in-buttons-element docs-flex docs-justify-center docs-w-full lg:docs-w-1/3"
>
Built-in Buttons
</div>
<div
class="panel disable-scroll-element docs-flex docs-justify-center docs-w-full lg:docs-w-1/3"
>
Disable Scroll
</div>
</div>
{{!-- <div class="docs-flex docs-flex-wrap">
<div class="docs-text-center docs-flex docs-justify-center docs-w-1/2">
<a
href="javascript:void(0)"
class="bottom-button toggleHelpModal"
{{on "click" this.toggleHelpModal}}
>
Modal Demo
</a>
</div>
<div class="docs-text-center docs-flex docs-justify-center docs-w-1/2">
<a
href="javascript:void(0)"
class="bottom-button toggleHelpNonmodal"
{{on "click" this.toggleHelpNonmodal}}
>
Non-modal
</a>
</div>
</div> --}}
<div class="docs-flex docs-justify-center">
<a
href="https://github.com/shipshapecode/shepherd"
class="shepherd-logo-link docs-flex docs-justify-center docs-mt-8"
>
<svg
height="196"
viewBox="0 0 241 196"
width="241"
xmlns="http://www.w3.org/2000/svg"
>
<g fill="none" transform="translate(0 -1)">
<g fill="#16202d">
<ellipse cx="117.35" cy="96.77" rx="82.95" ry="82.09" />
<path
d="m195.85 88.27 15.67 5.89 17.7.13 9.93 3.2-6.53 14.79-16.91 7.78-12.83.78-11.09-3.19-13.2-14.4s-15.53-36.69 17.26-14.98z"
/>
<path
d="m66 21.89c5.56-11.66 18.37-20.02 32.16-20.83 8.37-.49 15 1.89 21.41 6.28 0 0 38.45-14.37 51.82 21.45 5.15.1 35.64 7.91 30.39 69.24l-34.15-37.03c-11.591341 15.9779302-33.783256 19.8493342-50.1 8.74-15.250597 8.1651354-34.137113 4.5172206-45.25-8.74l-38.65 24.65s-6.49-57.15 32-63.46"
/>
<path
d="m63.24 79.76s-10.16 32.09-37.34 32.47c-27.18.38-26.65-19.1-18.52-24.23 16.46-10.46 29.47 8.58 38.32-19.3"
/>
<path
d="m25.11 114.42c-18.4 0-23-8.89-24.21-12.76-1.73-5.83.55-12.5 5.31-15.52 7-4.45 13.34-4 18.93-3.63 8.19.56 13.6.93 18.48-14.47.364508-1.1487523 1.5912477-1.7845079 2.74-1.42 1.1487522.364508 1.7845079 1.5912477 1.42 2.74-5.92 18.64-14.57 18.07-22.94 17.49-5.16-.35-10.49-.71-16.3 3-2.73 1.7-4.78 6.15-3.46 10.57 1.87 6.28 9.42 9.8 20.79 9.63 25.26-.35 35.19-30.64 35.29-30.95.4058039-1.089783 1.5955561-1.6691862 2.7037351-1.3167052 1.1081791.3524811 1.7445938 1.5127374 1.4462649 2.6367052-2.0768844 5.9848561-5.0398571 11.6242797-8.79 16.73-8.19 11.13-18.77 17.1-30.59 17.26z"
/>
</g>
<path
d="m170.77 144.52-12.29 20.27-9.34 6.86-11.2 3.49-14.47-.49-13.34 7.99-19.12 11.16h-14.46l-7.58-9.18-1.7-22.15-16.31-3.34-7.59-.05-9.71-10.94-1.15-14.29 3.15-7.21 9.11-9.78-1.4-14.5v-30.67l9.93-18.44 21.35-11.87 92.84-7.86 10.34 74.09z"
fill="#fff"
/>
<g fill="#16202d">
<path
d="m181.59 127.59-14.72 28.41-1.53-13.9v-6.19l-10.05-15.51-.41-8 6.19-12.17.59-17.47-10.91-21.48-14.58-6.69-18.2-2.19-21.2 7.76-18.3 20.47-.31-13.59-8.33-15.96-6.6.26-9.99 5.37 11.15-21.1 30.03 1.84 19.19-7.33 26.98 1.23 16.64 2.17h10.26l18.72 32.13 14.09 25.69-8.39 17.04z"
/>
<path
d="m169.3 146.93c7.48-5.56 13.92-11.46 19-19.23 5.152561-7.865617 8.816678-16.610687 10.81-25.8l-19.79-9-8.89 40.29zm-102.47 25.15 7.74.51.19 1.65 2.45 5 7.12 3.4 15.86-3.55 17.49-10 10.23-20.94s4.6-8.28-2.88-3.38l-12 9.4-14.47 6.84s-17.15 3.84-20.66 2.82c-7.01-2-11.33 2.26-11.07 8.25z"
/>
<path
d="m45.47 63c.67-1.12 1.36-2.23 2.09-3.32s1.53-2.16 2.44-3.18c.8608626-1.0652623 1.7965673-2.0678031 2.8-3 .52-.47 1.07-.91 1.65-1.34.3-.21.61-.42.94-.62l.52-.3c.22-.1.33-.17.72-.32l-.21.09c2.8593316-1.4481404 6.0497714-2.1172705 9.25-1.94 1.7005421.1604339 3.3472398.6820586 4.83 1.53 1.4250904.8302359 2.6914177 1.9069527 3.74 3.18 1.9107899 2.3858322 3.377418 5.0955377 4.33 8 .9518407 2.7503157 1.6808593 5.5727547 2.18 8.44.51 2.83.86 5.67 1.14 8.48l.21 2.09v.45s0 0 0-.15c-.0878162-.3375983-.280368-.6386793-.55-.86-.4380499-.3449642-.9977156-.4966156-1.55-.42-.2903574.0262385-.5708551.1185975-.82.27-.1185069.0709813-.2262627.1585329-.32.26-.11.13.07-.1.15-.22l.29-.4 2.38-3.44c3.2311504-4.7453857 6.915074-9.166094 11-13.2 4.1452334-4.116747 8.960591-7.4983186 14.24-10 5.371894-2.4910153 11.228793-3.7614331 17.15-3.72 5.869128.0960284 11.673803 1.2407077 17.14 3.38 5.62686 2.0384954 10.662793 5.4358611 14.66 9.89 3.911769 4.6199992 6.454109 10.2415505 7.34 16.23.857684 5.7975686.786796 11.6947234-.21 17.47-.960303 5.668064-2.398773 11.244646-4.3 16.67-.92 2.7-1.92 5.36-3 8-.54 1.32-1.09 2.63-1.66 3.92l-.44 1-.21.49-.06.12v.06c.188225-.427015.247322-.899792.17-1.36-.101521-.584131-.423754-1.106864-.9-1.46-.318027-.229022-.683881-.382886-1.07-.45h.16c.817394.133989 1.62315.331248 2.41.59 3.102935.998162 5.870882 2.831926 8 5.3 2.049884 2.453863 3.476987 5.366386 4.16 8.49.33067 1.49446.544648 3.012367.64 4.54 0 .75.08 1.52.06 2.24v1.09c0 .48 0 .87-.09 1.28-.400262 3.071534-1.359403 6.043853-2.83 8.77-2.879086 5.296894-7.126791 9.724176-12.3 12.82-4.992366 2.990182-10.567527 4.875848-16.35 5.53-.372026.034876-.716527-.198979-.821432-.557608s.059258-.741278.391432-.912392c4.982484-2.215599 9.780935-4.823816 14.35-7.8 4.404985-2.81466 8.040776-6.680696 10.58-11.25 1.176267-2.218528 1.945105-4.630037 2.27-7.12 0-.29.05-.6.06-.82v-1c0-.69 0-1.31-.05-2-.089083-1.265937-.276313-2.523047-.56-3.76-.514035-2.369719-1.594904-4.579495-3.15-6.44-1.566136-1.779636-3.589087-3.097147-5.85-3.81-.545281-.177044-1.10368-.310792-1.67-.4h-.09c-.430928-.073937-.840486-.241173-1.2-.49-.942518-.713207-1.262706-1.985642-.77-3.06v-.06-.12l.21-.48.42-.94 1.61-3.82c1.053333-2.553333 2.03-5.123333 2.93-7.71 1.821633-5.151927 3.209791-10.446998 4.15-15.83.957956-5.2816803 1.076076-10.6814815.35-16-.708576-5.1495241-2.84215-9.9985562-6.16-14-3.487617-3.9441238-7.894524-6.9667879-12.83-8.8-4.963759-2.0010722-10.249296-3.0852849-15.6-3.2-5.315839-.0578825-10.578521 1.0622731-15.41 3.28-4.842656 2.2805399-9.2623041 5.3678687-13.07 9.13-3.920649 3.8217272-7.4329022 8.0411229-10.48 12.59l-2.38 3.48-.32.45c-.1453704.2175897-.3057607.4247604-.48.62-.1488769.1666611-.3205773.3114281-.51.43-.2894255.1749194-.6137274.2841579-.95.32-1.0542152.0913759-2.0194107-.5944209-2.28-1.62-.0375182-.1309315-.0642739-.2647101-.08-.4v-.59l-.22-2.09c-.29-2.76-.64-5.48-1.14-8.15-.4660739-2.6440779-1.1347103-5.2484165-2-7.79-.8101352-2.4238018-2.0424357-4.6852764-3.64-6.68-1.3988664-1.7958044-3.466665-2.9469872-5.73-3.19-2.4360892-.0943237-4.8530339.4650263-7 1.62l-.2.09-.14.07-.29.17-.62.43c-.42.32-.84.67-1.25 1.05-.8368245.7864133-1.61241 1.6355457-2.32 2.54-.74.9-1.42 1.88-2.08 2.86s-1.27 2-1.87 3.08c-.632366 1.1045695-2.0404305 1.487366-3.145.855s-1.487366-2.0404305-.855-3.145z"
/>
<path
d="m93.21 123.5c-4.2873268-2.327061-8.7511008-4.31319-13.35-5.94-4.5188739-1.483345-9.2439007-2.242724-14-2.25-2.3508483.059164-4.6925016.316746-7 .77-2.2907082.498461-4.5302867 1.208163-6.69 2.12-4.3936011 1.9279-8.4911716 4.469943-12.17 7.55l-.73.46c.14-.06 0 0 0 0l-.13.09c-.1104579.074091-.2141903.157746-.31.25-.2201851.208024-.4210109.435627-.6.68-.3951089.568582-.7050473 1.191827-.92 1.85-.2354806.729039-.3995846 1.479228-.49 2.24l-.09 1.21v1.6l-.1.39c-.2255005.970716-.3792491 1.956713-.46 2.95-.0849539 1.031054-.1049934 2.06643-.06 3.1.0652325 2.041992.4290914 4.06343 1.08 6 .6443014 1.890264 1.6082993 3.655902 2.85 5.22 1.2773101 1.553472 2.7847451 2.902407 4.47 4l-.21-.12.49.21.65.22c.4559278.146965.9200518.267169 1.39.36.9600096.188472 1.9326792.305459 2.91.35 1.0013024.023727 2.0031241-.013006 3-.11 1-.11 2-.28 3-.49h.12c.6276425-.135824 1.283538-.014451 1.8210154.336976.5374774.351428.9117001.903594 1.0389846 1.533024.2535711 1.218433-.4544125 2.431503-1.64 2.81-1.1940193.397219-2.4179314.698181-3.66.9-2.5374949.426538-5.1325585.372262-7.65-.16-.6452704-.135966-1.2828403-.306208-1.91-.51-.32-.1-.64-.21-1-.34s-.6-.24-1.07-.48l-.09-.05-.11-.07c-2.116034-1.432195-4.0010735-3.178976-5.59-5.18-1.5887296-2.041107-2.8195379-4.337038-3.64-6.79-.7872685-2.413947-1.2118949-4.931375-1.26-7.47-.0203651-1.252565.0397587-2.505144.18-3.75.1394898-1.283661.3802398-2.554285.72-3.8l-.1.75v-1.57l.12-1.59c.1273628-1.097817.3652357-2.179971.71-3.23.3652428-1.125359.9015211-2.187798 1.59-3.15.3875931-.510278.8265622-.979405 1.31-1.4.2447142-.231311.5053539-.445169.78-.64l.45-.29c.205125-.125238.4190129-.235524.64-.33l-.73.46c3.7935634-3.828492 8.2312301-6.959569 13.11-9.25 5.016431-2.254184 10.4504082-3.429559 15.95-3.45 5.4323576.0603 10.8002191 1.184833 15.8 3.31 4.91 2.13 9.59 4.72 13.18 8.82.3572656.267949.5444434.706143.4910254 1.149519s-.3393164.824574-.75 1c-.4106836.175427-.8837598.11843-1.2410254-.149519zm46.44 39.03c-5.183435 7.367696-11.427602 13.928621-18.53 19.47-3.533084 2.863561-7.288249 5.441684-11.23 7.71-4.01184 2.34302-8.288681 4.199451-12.74 5.53-4.6094558 1.393484-9.444887 1.88246-14.24 1.44-2.4635927-.227885-4.8853204-.786227-7.2-1.66-2.470326-.913223-4.7219973-2.333718-6.61-4.17-1.8689586-1.899793-3.2723223-4.206786-4.1-6.74-.7506278-2.378825-1.144903-4.855682-1.17-7.35-.0202368-2.346558.1772763-4.689934.59-7 .2-1.14.42-2.26.66-3.36l.36-1.61c.12-.49.24-1.08.28-1.34v-.2c.2214409-1.180847 1.3110835-1.994813 2.5062375-1.872166 1.1951541.122647 2.0967685 1.140956 2.0737625 2.342166 0 .83-.13 1.33-.2 1.93l-.24 1.63c-.16 1.07-.3 2.12-.41 3.17-.2102371 2.042874-.2670629 4.098632-.17 6.15.0952967 1.921427.4726681 3.818392 1.12 5.63.6365233 1.647452 1.6068389 3.145483 2.85 4.4 2.5 2.38 6.25 3.58 10.23 3.89 4.016649.342884 8.0618622-.081321 11.92-1.25 7.93-2.26 15.39-6.64 22.42-11.57s13.58-10.75 20.14-16.53c.412497-.358147 1.026401-.355633 1.435949.005883.409549.361515.488235.97036.184051 1.424117zm-15.35-25.16c1.365168-1.078656 3.101039-1.574619 4.83-1.38 1.69091.159054 3.305981.778107 4.67 1.79 1.29383.963809 2.3648 2.195083 3.14 3.61.352241.68988.643354 1.409298.87 2.15.185317.74718.295861 1.510939.33 2.28.008083.224504-.074097.442891-.228181.60637s-.36723.258427-.591819.263677c-.158118.001591-.313693-.039896-.45-.120047h-.08c-.597008-.373745-1.165257-.791574-1.7-1.25-.56-.38-1-.8-1.52-1.17-1-.72-1.87-1.42-2.78-2s-1.78-1-2.73-1.54-2-1-3.27-1.52l-.29-.13c-.467356-.217322-.67255-.770455-.46-1.24.057708-.135621.146823-.255584.26-.35z"
/>
<path
d="m51.59 114.09s-7.07-34.45 6.53-37.79c11.05-2.71 3.42 13.79 6.67 35.72zm25.94 50.98c-.09 2.33-.2 4.67-.16 6.88.002976 1.042388.0932919 2.082694.27 3.11.1576975.903221.4616901 1.774667.9 2.58.3287454.661131.834067 1.218369 1.46 1.61.7032624.41371 1.4880442.669617 2.3.75.9623518.129167 1.9376482.129167 2.9 0 1.1-.16 2.23-.25 3.32-.48 8.7942127-1.460458 16.946687-5.529727 23.4-11.68 6.382514-6.325578 11.161788-14.084184 13.94-22.63.36-1.07.7-2.14 1-3.22l.45-1.63.11-.41c-.029781.097793-.049878.198276-.06.3-.019816.176111-.019816.353889 0 .53.040679.3864.182055.755357.41 1.07.398442.584791 1.043894.953621 1.75 1 .756341.069202 1.50003-.228274 2-.8-1.57393 1.848733-3.242846 3.614446-5 5.29-3.528037 3.370883-7.380025 6.385482-11.5 9-16.45 10.51-38.02 14.04-56.55 5.66-2.3355537-1.162003-4.4829337-2.668877-6.37-4.47-1.9139981-1.852721-3.4849028-4.029643-4.64-6.43-2.232139-4.759998-2.9309879-10.095709-2-15.27.06-.32.12-.64.2-1l.12-.51.1-.36.12-.33c.2869628-.723198.6560486-1.41104 1.1-2.05.8360158-1.15154 1.8484602-2.163984 3-3 2.1186716-1.554988 4.5253046-2.673325 7.08-3.29 4.775393-1.120108 9.7279797-1.262971 14.56-.42.4250401.066634.7158651.46484.65.89-.0457321.349555-.328739.620076-.68.65-4.5301013.343581-8.9987369 1.257467-13.3 2.72-1.9630802.734479-3.7911022 1.788717-5.41 3.12-.7036856.616273-1.3194343 1.326235-1.83 2.11-.2163332.332068-.3941455.687693-.53 1.06v.09.07l-.07.34-.12.76c-.6562117 4.150843-.0681397 8.403056 1.69 12.22 1.8877021 3.714939 4.9694138 6.68747 8.75 8.44 3.9718311 1.873301 8.2383172 3.043962 12.61 3.46 4.4500387.545057 8.9499613.545057 13.4 0 8.9305227-1.165004 17.4793-4.345149 25-9.3 3.798966-2.447126 7.36705-5.235319 10.66-8.33 1.643083-1.537889 3.205187-3.160074 4.68-4.86.671232-.776348 1.663777-1.198624 2.688603-1.143863 1.024827.054762 1.966719.580406 2.551397 1.423863.305383.439855.497715.948162.56 1.48.024935.25272.024935.50728 0 .76-.022748.171905-.056146.342233-.1.51l-.11.44-.49 1.76c-.35 1.18-.72 2.34-1.12 3.49-3.105717 9.379462-8.405995 17.88185-15.46 24.8-3.602992 3.442535-7.727145 6.294343-12.22 8.45-4.4782755 2.127972-9.2409865 3.596531-14.14 4.36-1.21.23-2.44.31-3.65.47-1.371446.169554-2.758554.169554-4.13 0-1.5273558-.204567-2.9933966-.733023-4.3-1.55-1.368471-.876046-2.4742513-2.106226-3.2-3.56-.6585492-1.273959-1.1108365-2.644322-1.34-4.06-.1824488-1.294952-.2593685-2.602588-.23-3.91 0-2.48.21-4.82.37-7.18.1135647-1.236989 1.1850445-2.162689 2.4254134-2.095424 1.240369.067265 2.2054582 1.103408 2.1845866 2.345424z"
/>
</g>
<path
d="m106.64 166.3s-15.41 1.23-18.91 7c0 0-2.81 1.05 0-3.5 2.36-3.85-6-.92-8.69 3.6-.8852702 1.484089-.7660427 3.359935.3 4.72 1.23 1.53 3.78 3.14 9 1.94 8.43-1.94 26.54-13.76 18.3-13.76z"
fill="#ff908a"
/>
<path
d="m44.77 119.170015c-1.0251963.003728-1.927964-.674369-2.21-1.660015-2.1341451-7.309956-3.1754111-14.89536-3.09-22.51 0-44.91 20.07-64.06 67.13-64.06 44.29 0 96 16.77 96 64.06-.110849 1.1874315-1.107406 2.0952909-2.3 2.0952909s-2.189151-.9078594-2.3-2.0952909c0-43.88-49.23-59.45-91.39-59.45-22.61-.05-37.75 4.23-47.61 13.45s-14.92 24.29-14.92 46c-.0766652 7.178515.907284 14.328996 2.92 21.22.348578 1.222461-.3515112 2.497782-1.57 2.86-.2149518.059543-.4369538.090015-.66.090015z"
fill="#16202d"
/>
<path
d="m40.18 79.6c.9866357-2.2356845 2.2498309-4.3387701 3.76-6.26 1.4963351-1.9514111 3.2372624-3.702421 5.18-5.21 1.9974867-1.5652063 4.250717-2.7730189 6.66-3.57 2.46998-.7282724 5.0760712-.8686794 7.61-.41.7823262.143251 1.3362274.8456857 1.2930939 1.6398486-.0431334.7941628-.6698547 1.4324742-1.4630939 1.4901514h-.14c-1.9759581.1363707-3.9123331.6204644-5.72 1.43-1.7684779.9279489-3.4116771 2.0771803-4.89 3.42-1.5084671 1.4156313-2.8965847 2.9542677-4.15 4.6-1.27 1.63-2.56 3.44-3.61 5.1l-.08.13c-.7138732 1.1032818-2.1535553 1.4763629-3.3134115.8586418-1.1598561-.6177211-1.6537055-2.0205707-1.1365885-3.2286418zm-4.12 46.06c1.3679783-1.062858 2.9461478-1.82297 4.63-2.23 1.9608429-.510172 4.0436044-.230077 5.8.78 1.7028567 1.127972 2.9474522 2.826437 3.51 4.79.2348313.858347.4184878 1.729881.55 2.61.06.85.13 1.69.16 2.54.0277842 1.244881-.9361342 2.287762-2.1793496 2.357878-1.2432153.070117-2.3182832-.857767-2.4306504-2.097878v-.26c0-.68-.07-1.36-.09-2s-.18-1.28-.29-1.9c-.2042162-1.007452-.7058137-1.930531-1.44-2.65-.8847668-.583064-1.9485528-.831281-3-.7-1.3599673.097306-2.7031102.359219-4 .78h-.12c-.2970365.093777-.6192056.065239-.8951316-.079294-.2759261-.144533-.4828284-.393127-.5748684-.690706-.1361566-.453171.0091149-.943953.37-1.25z"
fill="#16202d"
/>
<path d="m65.8 90.25-8.25 4.53 9.22 3.15z" fill="#fff" />
<ellipse
cx="69.16"
cy="128.89"
fill="#16202d"
rx="6.94"
ry="4.26"
/>
<path
d="m35.15 133.16c3.84 0 6.94-1.91 6.94-4.27s-2.18-4.26-6-4.26zm-11.37-122.48c1.02739 1.2771274 1.9503674 2.6348405 2.76 4.06.81 1.41 1.55 2.87 2.24 4.35.7116366 1.4860767 1.3100055 3.0237843 1.79 4.6.5075822 1.6673591.7802068 3.3973473.81 5.14-.0053624.7615584-.6185001 1.3791392-1.38 1.39-.2574591-.0052995-.50908-.0776836-.73-.21-1.4603595-.9547494-2.7827091-2.1054963-3.93-3.42-1.0798777-1.2569602-2.0627056-2.594141-2.94-4-.89-1.37-1.73-2.77-2.5-4.21-.7803025-1.4434198-1.448924-2.9444749-2-4.49-.4982225-1.5547583.1719689-3.2448706 1.6002955-4.03568175 1.4283265-.79081111 3.2164458-.46177366 4.2697045.78568175zm-19.18 15.56c1.60125044.3596246 3.16995024.8513066 4.69 1.47 1.51.6 3 1.29 4.45 2 1.481606.731206 2.9056818 1.573617 4.26 2.52 1.4304962.9942926 2.7160911 2.18229 3.82 3.53.2426402.2933888.3543175.673462.308956 1.0514747-.0453616.3780127-.2437909.7208731-.548956.9485253-.2032618.1574213-.4449625.2575545-.7.29-1.7365777.1564188-3.4864372.0722909-5.2-.25-1.6166185-.306267-3.2078073-.7341497-4.76-1.28-1.55-.52-3.08-1.1-4.57-1.75-1.50991831-.6669545-2.96449007-1.4527576-4.35-2.35-1.37167253-.9034094-1.90445341-2.6562677-1.26752823-4.1701899.63692518-1.5139221 2.26256559-2.3587068 3.86752823-2.0098101zm-2.76 25.94c1.4697982-.7255837 2.994524-1.3341365 4.56-1.82 1.56-.49 3.14-.9 4.73-1.26 1.6031823-.3668031 3.2307412-.6174538 4.87-.75 1.7360129-.1370234 3.4826409-.0326968 5.19.31.7500166.1739055 1.2218677.9172937 1.06 1.67-.0582047.2535574-.1863982.4856917-.37.67-1.2426308 1.2224118-2.6494826 2.2657708-4.18 3.1-1.4488713.7762266-2.9529387 1.444701-4.5 2-1.53.58-3.07 1.09-4.64 1.53-1.57655964.4648105-3.18865199.7992695-4.82 1-1.62388284.1493762-3.12734345-.8685532-3.59169326-2.4317832-.46434982-1.56323.2395966-3.2368588 1.68169326-3.9982168zm136.98 111.55s-4.51 7.89 3.11 5.35l-4 4-5.06-1.39s.83-7.4 5.95-7.96zm-93.11-52.5s.93 3.69 3.52 2.43l-1.76 2.08h-1.95zm4.95-47.85s-2.53 5 .28 3.45l-2.79 6.92-3-4.82z"
fill="#16202d"
/>
<path
d="m185.72 114.59c5.62 4.49 15.71 9 23.61 10.59l6.84 10.19c1.58 2-20.51-3.37-31.71-20-.46-.69.6-1.31 1.26-.78z"
fill="#fff"
/>
<path
d="m145.81 95.54c-.325093-4.660732-1.146406-9.2734923-2.45-13.76-1.15417-4.1783347-3.341341-7.9990056-6.36-11.11-3.199939-2.8826295-7.192871-4.7362421-11.46-5.32-4.673183-.6713907-9.409277-.78887-14.11-.35-.57241.0245851-1.079767-.3655601-1.203011-.9250857-.123243-.5595256.173244-1.1267291.703011-1.3449143 4.819091-1.9357139 9.989857-2.8417902 15.18-2.66 1.342023.0457671 2.678912.1894826 4 .43.68.11 1.34.33 2 .49l1 .28 1 .36c2.676563.9677754 5.136602 2.452633 7.24 4.37 2.087575 1.9035652 3.812208 4.1703224 5.09 6.69 1.2164 2.4307715 2.100966 5.0138414 2.63 7.68.504783 2.5782382.729421 5.2034838.67 7.83-.042425 2.6058814-.394905 5.1974481-1.05 7.72-.179952.6935464-.836591 1.1540139-1.549953 1.0869032s-1.272601-.641964-1.320047-1.3569032zm10.64 24.64c1.494476.98284 2.905869 2.086536 4.22 3.3 1.344551 1.277508 2.535894 2.707121 3.55 4.26 1.913094 3.117324 3.105477 6.622723 3.49 10.26.219734 1.701405.336613 3.414517.35 5.13.040221 1.750657-.046674 3.501924-.26 5.24-.502179 3.51846-1.662393 6.910897-3.42 10-3.538795 6.038043-8.848773 10.84181-15.21 13.76-3.126262 1.48462-6.456071 2.495695-9.88 3-1.715415.242917-3.448011.34326-5.18.3l-4.93-.14c-1.206992-.106624-2.122019-1.13503-2.087564-2.346233.034454-1.211202 1.006463-2.18593 2.217564-2.223767h.15c1.55.12 3.15.19 4.72.21 1.488177.050708 2.977854-.03633 4.45-.26 2.948954-.500745 5.80694-1.437679 8.48-2.78 5.378914-2.603177 9.831826-6.790869 12.76-12 1.382142-2.545887 2.264659-5.332605 2.6-8.21.249877-2.968465.145813-5.956115-.31-8.9-.350019-2.790888-1.324122-5.467107-2.85-7.83-.773222-1.128223-1.679777-2.159009-2.7-3.07-1.078667-.942499-2.232501-1.795333-3.45-2.55h-.07c-.918173-.589488-1.452111-1.624037-1.400685-2.713942.051425-1.089905.680402-2.069583 1.65-2.57s2.132512-.445546 3.050685.143942z"
fill="#16202d"
/>
<path
d="m200.3 93.87 28.11.57 9.32 4.56-2.73 10.36s-.27-10.62-10.29-10.45-21.98-.44-24.41-5.04zm-99.97-83.82c5.59 0 10.38 1.61 15.7 5.24l2.69 1.82 3-1.12c4.867651-1.6000965 9.956154-2.4268095 15.08-2.45 1.14 0 2.31 0 3.5.15 0 0 17.26 1.05 26.73 19.62-3.57-22.22-26.73-24-26.73-24-1.19-.11-2.36-.15-3.5-.15-5.123846.02319055-10.212349.8499035-15.08 2.45l-3 1.12-2.72-1.82c-5.32-3.63-10.11-5.24-15.7-5.24-.59 0-1.19 0-1.8 0-11.43.72-22.21 7.65-26.79 17.33 7.1701824-8.317046 17.6393843-13.05415869 28.62-12.95z"
fill="#8e8e8e"
/>
<path
d="m207.82 123c-24.74 0-34.44-25.13-34.54-25.4-.368665-1.079885.18798-2.2572042 1.256519-2.657568 1.068538-.4003638 2.261767.1213062 2.693481 1.177568.39 1 9.66 24.91 33.92 22.49 16.08-1.58 23.3-8.69 24.59-14.3.7-3.05-.29-5.66-2.72-7.15-3.07-1.9-8.44-1.75-14.11-1.59-11.4.32-25.6.71-32.42-14.61-.392502-1.0458137.098092-2.2163238 1.118967-2.6697517 1.020876-.4534279 2.218254-.0326401 2.731033.9597517 5.68 12.74 17.25 12.41 28.45 12.1 6.32-.18 12.3-.34 16.44 2.21 3.964216 2.4439164 5.845023 7.207 4.62 11.7-2.57 11.16-16.85 16.43-28.29 17.55-1.24266.126422-2.490925.19-3.74.19z"
fill="#16202d"
/>
<path
d="m137.35 108.69s-23.53-.29-33.4.38c.05 0 17.44-14.74 33.4-.38z"
fill="#cecece"
/>
<path
d="m136.33 109.54c-2.477033-1.510116-5.108715-2.750527-7.85-3.7-2.410385-.776388-4.940278-1.115062-7.47-1-2.679317.170881-5.333596.619963-7.92 1.34-2.73.71-5.61 1.68-8.6 2.56h-.18c-.630691.177226-1.305329-.053139-1.69591-.579092s-.416076-1.238382-.06409-1.790908c1.957214-2.93382 4.609175-5.338448 7.72-7 3.204406-1.804634 6.803389-2.7936675 10.48-2.88 3.845762-.1162779 7.637297.9291822 10.88 3 3.038981 1.989973 5.392103 4.866786 6.74 8.24.220006.553709.065457 1.186001-.385167 1.57579-.450623.389789-1.098581.451666-1.614833.15421z"
fill="#16202d"
/>
<path
d="m114.25 92.92c-.82 1.32-1.75 2.59-2.66 3.83s-1.82 2.44-2.67 3.67-1.71 2.42-2.44 3.64c-.748151 1.221092-1.393699 2.502153-1.93 3.83v.11c-.213968.548245-.830522.82078-1.38.61-.315616-.127622-.555211-.39302-.65-.72-.404378-1.808236-.28999-3.693904.33-5.44.534723-1.661109 1.316847-3.2321005 2.32-4.66.94743-1.400962 2.043825-2.6951772 3.27-3.86 1.188254-1.1940375 2.534024-2.2201873 4-3.05.676637-.3719975 1.526709-.1259242 1.9.55.249604.4404272.249604.9795728 0 1.42z"
fill="#16202d"
/>
</g>
</svg>
</a>
</div>
</div>
</div>
<div class="test-modal-container"></div>
================================================
FILE: test-app/app/templates/docs/faq.md
================================================
## Q/A
### Q: Woah, events? How does that work with buttons?
A: Don't worry, it's not too bad! You can just set up an action to start (or cancel, or advance, etc.) the tour like so:
```js
// app/routes/application.js
import Route from "@ember/routing/route";
import { service } from "@ember/service";
export default Route.extend({
tour: service(),
actions: {
startTour() {
this.tour.start();
},
},
});
```
### Q: How do I make a tour span multiple route transitions?
A : You can use `beforeShowPromise` to ensure you have fully transitioned to the new route before showing
the step by doing something like this:
```js
beforeShowPromise() {
return new Promise(function(resolve) {
router.transitionTo('myurl').finally(() => {
Ember.run.scheduleOnce('afterRender', this, function() {
resolve();
});
});
});
}
```
================================================
FILE: test-app/app/templates/docs/index.md
================================================
# ember-shepherd
<a href="https://shipshape.io/"><img src="http://i.imgur.com/DWHQjA5.png" alt="Ship Shape" width="100" height="100"/></a>
**[ember-shepherd is built and maintained by Ship Shape. Contact us for Ember.js consulting, development, and training for your project](https://shipshape.io/ember-consulting/)**.
[](http://badge.fury.io/js/ember-shepherd)
[]()
[](http://emberobserver.com/addons/ember-shepherd)
[](https://github.com/RobbieTheWagner/ember-shepherd/actions/workflows/ci.yml)
## Installation
```
ember install ember-shepherd
```
================================================
FILE: test-app/app/templates/docs/not-found.hbs
================================================
<div class="docs-container">
<h1>Not found</h1>
<p>This page doesn't exist. <LinkTo @route="index">Head home?</LinkTo></p>
</div>
================================================
FILE: test-app/app/templates/docs/usage.md
================================================
## Usage
The styles are no longer automatically added for Shepherd. You will need to add them to your styles manually. How you do this will vary depending on your app, but one possible way is to add this to your app's CSS:
```css
@import url("https://cdn.jsdelivr.net/npm/shepherd.js@14.3.0/dist/css/shepherd.min.css");
```
Most of the usage documentation can be found in the [API Reference for the Tour Service](api/services/tour).
## Step Options
See the [Step docs](https://docs.shepherdjs.dev/api/step/interfaces/stepoptions/) for all available Step options.
## Interacting with `ember-shepherd`
`ember-shepherd` uses the [`Ember.Evented`](http://emberjs.com/api/classes/Ember.Evented.html) mixin to manage events. The API is demonstrated below.
```js
// Start the tour
this.tour.start();
//Show a specific step
this.tour.show(id);
// Stop the tour
this.tour.cancel();
// Go to the next step
this.tour.next();
// Go to the previous step
this.tour.back();
```
================================================
FILE: test-app/app/templates/docs.hbs
================================================
<DocsViewer as |viewer|>
<viewer.nav as |nav|>
<nav.section @label="Introduction" />
<nav.item @label="Introduction" @route="docs.index" />
<nav.item @label="Usage" @route="docs.usage" />
<nav.section @label="Demo" />
<nav.item @label="Demo" @route="docs.demo" />
<nav.section @label="FAQ" />
<nav.item @label="FAQ" @route="docs.faq" />
</viewer.nav>
<viewer.main>
<div class="docs-container">
<div class="docs-section">
{{outlet}}
</div>
</div>
</viewer.main>
</DocsViewer>
================================================
FILE: test-app/app/templates/index.hbs
================================================
<section class="hero docs-flex docs-flex-wrap docs-justify-center">
<div class="section-content docs-mt-8 docs-mb-8 docs-w-full docs-max-w-4xl">
<div
class="docs-flex docs-flex-wrap docs-items-center docs-flex-col-reverse docs-justify-between lg:docs-flex-row"
>
<div class="docs-w-full lg:docs-pr-12 lg:docs-w-1/2">
<div class="docs-max-w-md">
<div class="docs-max-w-sm docs-mx-auto">
<h1>
<span class="docs-max-w-sm">
{{svg-jar
"ember"
class="docs-h-full docs-w-auto docs-max-w-full docs-fill-current"
height="auto"
width="125px"
}}
</span>
Shepherd
</h1>
<p
class="docs-mt-4 xl:docs-mt-6 docs-mb-2 docs-leading-small docs-mx-auto docs-tracking-tight docs-text-large-1 md:docs-text-large-2 xl:docs-text-large-3"
>
An Ember addon for the site tour library Shepherd
</p>
<LinkTo
@route="docs"
class="docs-no-underline docs-text-brand docs-text-xs docs-px-3 docs-py-2 docs-rounded docs-mt-4 docs-shadow-md hover:docs-shadow-lg docs-transition hover:docs-nudge-t docs-font-bold docs-inline-block docs-uppercase"
>
Read the docs →
</LinkTo>
</div>
</div>
</div>
<div
class="docs-w-full docs-text-center lg:docs-pr-12 lg:docs-w-1/2 lg:docs-p-12"
>
{{svg-jar "ember-consulting"}}
</div>
</div>
</div>
</section>
================================================
FILE: test-app/config/addon-docs.js
================================================
/* eslint-env node */
'use strict';
const AddonDocsConfig = require('ember-cli-addon-docs/lib/config');
module.exports = class extends AddonDocsConfig {
// See https://ember-learn.github.io/ember-cli-addon-docs/docs/deploying
// for details on configuration you can override here.
};
================================================
FILE: test-app/config/deploy.js
================================================
'use strict';
module.exports = function (deployTarget) {
let ENV = {
build: {},
// include other plugin configuration that applies to all deploy targets here
};
if (deployTarget === 'development') {
ENV.build.environment = 'development';
// configure other plugins for development deploy target here
}
if (deployTarget === 'staging') {
ENV.build.environment = 'production';
// configure other plugins for staging deploy target here
}
if (deployTarget === 'production') {
ENV.build.environment = 'production';
// configure other plugins for production deploy target here
}
// Note: if you need to build some configuration asynchronously, you can return
// a promise that resolves with the ENV object instead of returning the
// ENV object synchronously.
return ENV;
};
================================================
FILE: test-app/config/ember-cli-update.json
================================================
{
"schemaVersion": "1.0.0",
"packages": [
{
"name": "@ember-tooling/classic-build-app-blueprint",
"version": "6.10.0",
"blueprints": [
{
"name": "@ember-tooling/classic-build-app-blueprint",
"isBaseBlueprint": true,
"options": [
"--no-welcome",
"--pnpm",
"--ci-provider=github",
"--typescript"
]
}
]
}
]
}
================================================
FILE: test-app/config/ember-try.js
================================================
'use strict';
const getChannelURL = require('ember-source-channel-url');
const { embroiderSafe, embroiderOptimized } = require('@embroider/test-setup');
module.exports = async function () {
return {
usePnpm: true,
scenarios: [
{
name: 'ember-lts-4.8',
npm: {
devDependencies: {
'ember-resolver': '^11.0.1',
'ember-source': '~4.8.0',
},
},
},
{
name: 'ember-lts-4.12',
npm: {
devDependencies: {
'ember-source': '~4.12.0',
},
},
},
{
name: 'ember-lts-5.4',
npm: {
devDependencies: {
'ember-source': '~5.4.0',
},
},
},
{
name: 'ember-release',
npm: {
devDependencies: {
'ember-source': await getChannelURL('release'),
},
},
},
{
name: 'ember-beta',
npm: {
devDependencies: {
'ember-source': await getChannelURL('beta'),
},
},
},
{
name: 'ember-canary',
npm: {
devDependencies: {
'ember-source': await getChannelURL('canary'),
},
},
},
embroiderSafe(),
embroiderOptimized(),
],
};
};
================================================
FILE: test-app/config/environment.js
================================================
'use strict';
module.exports = function (environment) {
const ENV = {
modulePrefix: 'test-app',
environment,
rootURL: '/',
locationType: 'history',
EmberENV: {
EXTEND_PROTOTYPES: false,
FEATURES: {
// Here you can enable experimental features on an ember canary build
// e.g. EMBER_NATIVE_DECORATOR_SUPPORT: true
},
},
APP: {
// Here you can pass flags/options to your application instance
// when it is created
},
};
if (environment === 'development') {
// ENV.APP.LOG_RESOLVER = true;
// ENV.APP.LOG_ACTIVE_GENERATION = true;
// ENV.APP.LOG_TRANSITIONS = true;
// ENV.APP.LOG_TRANSITIONS_INTERNAL = true;
// ENV.APP.LOG_VIEW_LOOKUPS = true;
}
if (environment === 'test') {
// Testem prefers this...
ENV.locationType = 'none';
// keep test console output quieter
ENV.APP.LOG_ACTIVE_GENERATION = false;
ENV.APP.LOG_VIEW_LOOKUPS = false;
ENV.APP.rootElement = '#ember-testing';
ENV.APP.autoboot = false;
}
if (environment === 'production') {
// Allow ember-cli-addon-docs to update the rootURL in compiled assets
ENV.rootURL = 'ADDON_DOCS_ROOT_URL';
}
return ENV;
};
================================================
FILE: test-app/config/optional-features.json
================================================
{
"application-template-wrapper": false,
"default-async-observers": true,
"jquery-integration": false,
"template-only-glimmer-components": true,
"no-implicit-route-model": true
}
================================================
FILE: test-app/config/targets.js
================================================
'use strict';
const browsers = [
'last 1 Chrome versions',
'last 1 Firefox versions',
'last 1 Safari versions',
];
module.exports = {
browsers,
};
================================================
FILE: test-app/ember-cli-build.js
================================================
'use strict';
const EmberApp = require('ember-cli/lib/broccoli/ember-app');
// const { Webpack } = require('@embroider/webpack');
module.exports = function (defaults) {
let app = new EmberApp(defaults, {
autoImport: {
watchDependencies: ['ember-shepherd'],
},
'ember-cli-addon-docs': {
documentingAddonAt: '../ember-shepherd',
},
'ember-cli-babel': { enableTypeScriptTransform: true },
});
return app.toTree();
// const { maybeEmbroider } = require('@embroider/test-setup');
// return maybeEmbroider(app);
// return require('@embroider/compat').compatBuild(app, Webpack, {
// staticAddonTrees: true,
// staticAddonTestSupportTrees: true,
// staticHelpers: true,
// staticModifiers: true,
// staticComponents: true,
// staticEmberSource: true,
// packagerOptions: {
// webpackConfig: {
// // slow, but highest fidelity
// devtool: 'source-map',
// module: {
// rules: [
// {
// test: /\.(png|svg|jpg|jpeg|gif)$/i,
// type: 'asset/resource',
// },
// {
// test: /\.(woff|woff2|eot|ttf|otf)$/i,
// type: 'asset/resource',
// },
// ],
// },
// },
// },
// });
};
================================================
FILE: test-app/eslint.config.mjs
================================================
/**
* Debugging:
* https://eslint.org/docs/latest/use/configure/debug
* ----------------------------------------------------
*
* Print a file's calculated configuration
*
* npx eslint --print-config path/to/file.js
*
* Inspecting the config
*
* npx eslint --inspect-config
*
*/
import { fileURLToPath } from 'node:url';
import { dirname } from 'node:path';
import globals from 'globals';
import js from '@eslint/js';
import ts from 'typescript-eslint';
import ember from 'eslint-plugin-ember/recommended';
import eslintConfigPrettier from 'eslint-config-prettier';
import qunit from 'eslint-plugin-qunit';
import n from 'eslint-plugin-n';
import babelParser from '@babel/eslint-parser';
const parserOptions = {
esm: {
js: {
ecmaFeatures: { modules: true },
ecmaVersion: 'latest',
requireConfigFile: false,
babelOptions: {
plugins: [
[
'@babel/plugin-proposal-decorators',
{ decoratorsBeforeExport: true },
],
],
},
},
ts: {
projectService: true,
tsconfigRootDir: dirname(fileURLToPath(import.meta.url)),
},
},
};
export default ts.config(
js.configs.recommended,
ember.configs.base,
ember.configs.gjs,
ember.configs.gts,
eslintConfigPrettier,
/**
* Ignores must be in their own object
* https://eslint.org/docs/latest/use/configure/ignore
*/
{
ignores: ['dist/', 'node_modules/', 'coverage/', '!**/.*'],
},
/**
* https://eslint.org/docs/latest/use/configure/configuration-files#configuring-linter-options
*/
{
linterOptions: {
reportUnusedDisableDirectives: 'error',
},
},
{
files: ['**/*.js'],
languageOptions: {
parser: babelParser,
},
},
{
files: ['**/*.{js,gjs}'],
languageOptions: {
parserOptions: parserOptions.esm.js,
globals: {
...globals.browser,
},
},
},
{
files: ['**/*.{ts,gts}'],
languageOptions: {
parser: ember.parser,
parserOptions: parserOptions.esm.ts,
},
extends: [...ts.configs.recommendedTypeChecked, ember.configs.gts],
},
{
...qunit.configs.recommended,
files: ['tests/**/*-test.{js,gjs,ts,gts}'],
plugins: {
qunit,
},
},
/**
* CJS node files
*/
{
...n.configs['flat/recommended-script'],
files: [
'**/*.cjs',
'config/**/*.js',
'tests/dummy/config/**/*.js',
'testem.js',
'testem*.js',
'index.js',
'.prettierrc.js',
'.stylelintrc.js',
'.template-lintrc.js',
'ember-cli-build.js',
],
plugins: {
n,
},
languageOptions: {
sourceType: 'script',
ecmaVersion: 'latest',
globals: {
...globals.node,
},
},
},
/**
* ESM node files
*/
{
...n.configs['flat/recommended-module'],
files: ['**/*.mjs'],
plugins: {
n,
},
languageOptions: {
sourceType: 'module',
ecmaVersion: 'latest',
parserOptions: parserOptions.esm.js,
globals: {
...globals.node,
},
},
},
);
================================================
FILE: test-app/package.json
================================================
{
"name": "test-app",
"version": "0.0.0",
"private": true,
"description": "Test app for ember-shepherd addon",
"repository": "https://github.com/RobbieTheWagner/ember-shepherd",
"license": "MIT",
"author": "",
"directories": {
"doc": "doc",
"test": "tests"
},
"scripts": {
"build": "ember build --environment=production",
"format": "prettier . --cache --write",
"lint": "concurrently \"pnpm:lint:*(!fix)\" --names \"lint:\" --prefixColors auto",
"lint:css": "stylelint \"**/*.css\"",
"lint:css:fix": "concurrently \"pnpm:lint:css -- --fix\"",
"lint:fix": "concurrently \"pnpm:lint:*:fix\" --names \"fix:\" --prefixColors auto && pnpm format",
"lint:format": "prettier . --cache --check",
"lint:hbs": "ember-template-lint .",
"lint:hbs:fix": "ember-template-lint . --fix",
"lint:js": "eslint . --cache",
"lint:js:fix": "eslint . --fix",
"start": "ember serve",
"test": "concurrently \"pnpm:lint\" \"pnpm:test:*\" --names \"lint,test:\" --prefixColors auto",
"test:ember": "ember test"
},
"dependencies": {
"ember-shepherd": "workspace:*"
},
"devDependencies": {
"@babel/core": "^7.29.0",
"@babel/eslint-parser": "^7.28.6",
"@babel/helper-module-imports": "^7.28.6",
"@babel/plugin-proposal-decorators": "^7.29.0",
"@ember-data/adapter": "~5.7.0",
"@ember-data/graph": "~5.7.0",
"@ember-data/json-api": "~5.8.1",
"@ember-data/legacy-compat": "~5.7.0",
"@ember-data/model": "~5.7.0",
"@ember-data/request": "~5.7.0",
"@ember-data/request-utils": "~5.8.1",
"@ember-data/serializer": "~5.7.0",
"@ember-data/store": "~5.7.0",
"@ember/optional-features": "^2.3.0",
"@ember/test-helpers": "^5.4.1",
"@embroider/macros": "^1.19.6",
"@embroider/test-setup": "^4.0.0",
"@eslint/js": "^9.39.2",
"@glimmer/component": "^1.1.2",
"@glimmer/tracking": "^1.1.2",
"@glint/environment-ember-loose": "^1.5.2",
"@glint/environment-ember-template-imports": "^1.5.2",
"@glint/template": "^1.7.4",
"@tsconfig/ember": "^3.0.12",
"@types/qunit": "^2.19.13",
"@types/rsvp": "^4.0.9",
"@warp-drive/core-types": "~5.7.0",
"@warp-drive/ember": "~5.7.0",
"broccoli-asset-rev": "^3.0.0",
"concurrently": "^9.2.1",
"ember-auto-import": "^2.12.0",
"ember-cli": "~6.10.0",
"ember-cli-addon-docs": "^10.1.0",
"ember-cli-addon-docs-yuidoc": "^1.1.0",
"ember-cli-app-version": "^7.0.0",
"ember-cli-babel": "^8.3.1",
"ember-cli-clean-css": "^3.0.0",
"ember-cli-dependency-checker": "^3.3.3",
"ember-cli-deploy": "^2.0.0",
"ember-cli-deploy-build": "^3.0.0",
"ember-cli-deploy-git": "^1.3.4",
"ember-cli-deploy-git-ci": "^1.0.1",
"ember-cli-deprecation-workflow": "^3.4.0",
"ember-cli-htmlbars": "^6.3.0",
"ember-cli-inject-live-reload": "^2.1.0",
"ember-cli-sri": "^2.1.1",
"ember-cli-terser": "^4.0.2",
"ember-data": "~5.7.0",
"ember-inflector": "^6.0.0",
"ember-load-initializers": "^3.0.1",
"ember-modifier": "^4.2.2",
"ember-page-title": "^9.0.3",
"ember-qunit": "^9.0.4",
"ember-resolver": "^13.1.1",
"ember-shepherd": "workspace:*",
"ember-shiki": "^0.3.0",
"ember-source": "~6.10.1",
"ember-source-channel-url": "^3.0.0",
"ember-template-imports": "^4.4.0",
"ember-template-lint": "^6.1.0",
"ember-try": "^3.0.0",
"eslint": "^9.39.2",
"eslint-config-prettier": "^9.1.2",
"eslint-plugin-ember": "^12.7.5",
"eslint-plugin-n": "^17.23.2",
"eslint-plugin-qunit": "^8.2.5",
"globals": "^15.15.0",
"liquid-fire": "^0.37.1",
"loader.js": "^4.7.0",
"prettier": "^3.8.1",
"prettier-plugin-ember-template-tag": "^2.1.3",
"qunit": "^2.25.0",
"qunit-dom": "^3.5.0",
"stylelint": "^16.26.1",
"stylelint-config-standard": "^40.0.0",
"tracked-built-ins": "^4.1.0",
"typescript": "^5.9.3",
"typescript-eslint": "^8.54.0",
"velocity-animate": "^1.5.2",
"webpack": "^5.105.0"
},
"engines": {
"node": ">= 20.19"
},
"ember": {
"edition": "octane"
}
}
================================================
FILE: test-app/public/crossdomain.xml
================================================
<?xml version="1.0"?>
<!DOCTYPE cross-domain-policy SYSTEM "http://www.adobe.com/xml/dtds/cross-domain-policy.dtd">
<cross-domain-policy>
<!-- Read this: www.adobe.com/devnet/articles/crossdomain_policy_file_spec.html -->
<!-- Most restrictive policy: -->
<site-control permitted-cross-domain-policies="none"/>
<!-- Least restrictive policy: -->
<!--
<site-control permitted-cross-domain-policies="all"/>
<allow-access-from domain="*" to-ports="*" secure="false"/>
<allow-http-request-headers-from domain="*" headers="*" secure="false"/>
-->
</cross-domain-policy>
================================================
FILE: test-app/public/robots.txt
================================================
# http://www.robotstxt.org
User-agent: *
Disallow:
================================================
FILE: test-app/testem.js
================================================
'use strict';
module.exports = {
test_page: 'tests/index.html?hidepassed',
disable_watching: true,
launch_in_ci: ['Chrome'],
launch_in_dev: ['Chrome'],
browser_start_timeout: 120,
browser_args: {
Chrome: {
ci: [
// --no-sandbox is needed when running Chrome inside a container
process.env.CI ? '--no-sandbox' : null,
'--headless',
'--disable-dev-shm-usage',
'--disable-software-rasterizer',
'--mute-audio',
'--remote-debugging-port=0',
'--window-size=1440,900',
].filter(Boolean),
},
},
};
================================================
FILE: test-app/tests/acceptance/ember-shepherd-test.js
================================================
import { module, test } from 'qunit';
import { visit, click, find } from '@ember/test-helpers';
import { setupApplicationTest } from 'ember-qunit';
import { builtInButtons, steps as defaultSteps } from '../data';
const toggleTour = async (tour, modal) => {
tour.set('modal', modal);
await tour.addSteps(defaultSteps);
return await tour.start();
};
module('Acceptance | Tour functionality tests', function (hooks) {
let tour;
setupApplicationTest(hooks);
hooks.beforeEach(function () {
tour = this.owner.lookup('service:tour');
tour.set('confirmCancel', false);
tour.set('modal', true);
});
hooks.afterEach(async function () {
return await tour.complete();
});
module('Cancel link', function () {
test('Shows cancel link', async function (assert) {
await visit('/docs/demo');
await toggleTour(tour, true);
const cancelIcon = document.querySelector('.shepherd-cancel-icon');
assert.ok(cancelIcon, 'Cancel icon shown');
});
test('Hides cancel link', async function (assert) {
const defaultStepOptions = {
cancelIcon: {
enabled: false,
},
classes: 'shepherd-theme-arrows test-defaults',
};
const steps = [
{
attachTo: {
element: '.first-element',
on: 'bottom',
},
buttons: [builtInButtons.cancel, builtInButtons.next],
cancelIcon: {
enabled: false,
},
id: 'step-without-cancel-icon',
},
];
await visit('/docs/demo');
tour.set('defaultStepOptions', defaultStepOptions);
await tour.addSteps(steps);
tour.start();
assert.notOk(
document.querySelector('.shepherd-element button.shepherd-cancel-icon'),
);
});
test('Cancel link cancels the tour', async function (assert) {
await visit('/docs/demo');
await toggleTour(tour, true);
assert.dom('.shepherd-enabled').exists();
await click(
document.querySelector('.shepherd-content button.shepherd-cancel-icon'),
);
assert.dom('.shepherd-enabled').doesNotExist();
});
});
module('Required Elements', function () {
test('Does not warn about required elements when none are specified', async function (assert) {
await visit('/docs/demo');
await toggleTour(tour, true);
assert
.dom('.shepherd-element', document.body)
.hasAttribute('data-shepherd-step-id', defaultSteps[0].id);
});
test('Does not warn about required elements when none are missing', async function (assert) {
const requiredElements = [
{
selector: 'body',
message: 'Body element not found 🤔',
title: 'Error',
},
];
tour.set('requiredElements', requiredElements);
await visit('/docs/demo');
await toggleTour(tour, true);
assert
.dom('.shepherd-element', document.body)
.hasAttribute('data-shepherd-step-id', defaultSteps[0].id);
});
test('Warns about missing required elements when all are not present', async function (assert) {
const requiredElements = [
{
selector: '👻',
message: '👻 element not found',
title: 'Missing Required Elements',
},
];
tour.set('requiredElements', requiredElements);
await visit('/docs/demo');
await toggleTour(tour, true);
assert
.dom('.shepherd-element', document.body)
.hasAttribute('data-shepherd-step-id', 'error');
});
});
module('Tour options', function () {
test('Defaults applied', async function (assert) {
const stepsWithoutClasses = [
{
attachTo: {
element: '.first-element',
on: 'bottom',
},
buttons: [builtInButtons.cancel, builtInButtons.next],
id: 'test-highlight',
},
];
await visit('/docs/demo');
await tour.addSteps(stepsWithoutClasses);
tour.start();
assert.ok(
document.querySelector('.custom-default-class'),
'defaults class applied',
);
});
test('configuration works with attachTo object when element is a simple string', async function (assert) {
const steps = [
{
attachTo: {
element: '.first-element',
on: 'bottom',
},
buttons: [builtInButtons.cancel, builtInButtons.next],
id: 'test-attachTo-string',
},
];
await tour.addSteps(steps);
await visit('/docs/demo');
tour.start();
assert.ok(document.querySelector('.shepherd-element'), 'tour is visible');
});
test('configuration works with attachTo object when element is dom element', async function (assert) {
await visit('/docs/demo');
const steps = [
{
attachTo: {
element: find('.first-element'),
on: 'bottom',
},
buttons: [builtInButtons.cancel, builtInButtons.next],
id: 'test-attachTo-dom',
},
];
await tour.addSteps(steps);
tour.start();
assert.ok(document.querySelector('.shepherd-element'), 'tour is visible');
});
test('buttons work when type is not specified and passed action is triggered', async function (assert) {
let buttonActionCalled = false;
const steps = [
{
attachTo: {
element: '.first-element',
on: 'bottom',
},
buttons: [
{
classes: 'shepherd-button-secondary button-one',
text: 'button one',
},
{
classes: 'shepherd-button-secondary button-two',
text: 'button two',
action() {
buttonActionCalled = true;
},
},
{
classes: 'shepherd-button-secondary button-three',
text: 'button three',
},
],
id: 'test-buttons-custom-action',
},
];
await visit('/docs/demo');
await tour.addSteps(steps);
await tour.start();
assert.ok(
document.querySelector('.button-one'),
'tour button one is visible',
);
assert.ok(
document.querySelector('.button-two'),
'tour button two is visible',
);
assert.ok(
document.querySelector('.button-three'),
'tour button three is visible',
);
await click(document.querySelector('.button-two'));
assert.ok(buttonActionCalled, 'button action triggered');
});
test('scrollTo works with disableScroll on', async function (assert) {
// Setup controller tour settings
tour.set('disableScroll', true);
tour.set('scrollTo', true);
// Visit route
await visit('/docs/demo');
document.querySelector('#ember-testing-container').scrollTop = 0;
assert.strictEqual(
document.querySelector('#ember-testing-container').scrollTop,
0,
'Scroll is initially 0',
);
await tour.start();
await click(document.querySelector('.shepherd-content .next-button'));
await click(document.querySelector('.shepherd-content .next-button'));
assert.ok(
document.querySelector('#ember-testing-container').scrollTop > 0,
'Scrolled down correctly',
);
});
test('scrollTo works with a custom scrollToHandler', async function (assert) {
const done = assert.async();
// Override default behavior
const steps = [
{
attachTo: {
element: '.first-element',
on: 'bottom',
},
buttons: [builtInButtons.cancel, builtInButtons.next],
id: 'intro',
scrollTo: true,
scrollToHandler() {
document.querySelector('#ember-testing-container').scrollTop = 120;
assert.strictEqual(
document.querySelector('#ember-testing-container').scrollTop,
120,
'Scrolled correctly',
);
done();
},
},
];
// Visit route
await visit('/docs/demo');
await tour.addSteps(steps);
document.querySelector('#ember-testing-container').scrollTop = 0;
assert.strictEqual(
document.querySelector('#ember-testing-container').scrollTop,
0,
'Scroll is initially 0',
);
await tour.start();
await click(document.querySelector('.shepherd-content .next-button'));
});
test('scrollTo works without a custom scrollToHandler', async function (assert) {
// Setup controller tour settings
tour.set('scrollTo', true);
// Visit route
await visit('/docs/demo');
document.querySelector('#ember-testing-container').scrollTop = 0;
assert.strictEqual(
document.querySelector('#ember-testing-container').scrollTop,
0,
'Scroll is initially 0',
);
await tour.start();
await click(document.querySelector('.shepherd-content .next-button'));
assert.ok(
document.querySelector('#ember-testing-container').scrollTop > 0,
'Scrolled correctly',
);
});
test('Show by id works', async function (assert) {
await visit('/docs/demo');
tour.show('usage');
assert.strictEqual(
tour.get('tourObject').currentStep.el.querySelector('.shepherd-text')
.textContent,
'To use the tour service, simply inject it into your application and use it like this example.',
'Usage step shown',
);
});
test('hide method hides the current step', async function (assert) {
await visit('/docs/demo');
tour.show('usage');
tour.hide();
assert.false(
tour.get('tourObject').currentStep.isOpen(),
'The step is hidden',
);
});
});
});
================================================
FILE: test-app/tests/data.js
================================================
export const builtInButtons = {
cancel: {
classes: 'cancel-button',
secondary: true,
text: 'Exit',
type: 'cancel',
},
next: {
classes: 'next-button',
text: 'Next',
type: 'next',
},
back: {
classes: 'back-button',
text: 'Back',
type: 'back',
},
};
export const defaultStepOptions = {
classes: 'shepherd-theme-arrows custom-default-class',
scrollTo: true,
cancelIcon: {
enabled: true,
},
};
export const steps = [
{
attachTo: {
element: '.first-element',
on: 'bottom',
},
buttons: [builtInButtons.cancel, builtInButtons.next],
classes: 'custom-class-name-1 custom-class-name-2',
id: 'intro',
title: 'Welcome to Ember Shepherd!',
text: `
<p>
Ember Shepherd is a JavaScript library for guiding users through your Ember app.
It is an Ember addon that wraps <a href="https://github.com/shipshapecode/shepherd">Shepherd</a>
and extends its functionality. Shepherd uses <a href="https://popper.js.org/">Popper.js</a>,
another open source library, to render dialogs for each tour "step".
</p>
<p>
Popper makes sure your steps never end up off screen or cropped by an
overflow. Try resizing your browser to see what we mean.
</p>`,
},
{
attachTo: {
element: '.install-element .shiki-code-block',
on: 'bottom',
},
buttons: [builtInButtons.cancel, builtInButtons.back, builtInButtons.next],
classes: 'custom-class-name-1 custom-class-name-2',
id: 'installation',
title: 'Installation',
text: 'Installation is simple, if you are using Ember-CLI, just install like any other addon.',
},
{
attachTo: {
element: '.usage-element .shiki-code-block',
on: 'bottom',
},
buttons: [builtInButtons.cancel, builtInButtons.back, builtInButtons.next],
classes: 'custom-class-name-1 custom-class-name-2',
id: 'usage',
title: 'Usage',
text: 'To use the tour service, simply inject it into your application and use it like this example.',
},
{
attachTo: {
element: '.modal-element',
on: 'top',
},
buttons: [builtInButtons.cancel, builtInButtons.back, builtInButtons.next],
classes: 'custom-class-name-1 custom-class-name-2',
id: 'modal',
text: `
<p>
We implemented true modal functionality by disabling clicking of the rest of the page.
</p>
<p>
If you would like to enable modal, simply do this.tour.set('modal', true).
</p>`,
},
{
attachTo: {
element: '.built-in-buttons-element',
on: 'top',
},
buttons: [builtInButtons.cancel, builtInButtons.back, builtInButtons.next],
classes: 'custom-class-name-1 custom-class-name-2',
id: 'buttons',
text: `For the common button types ("next", "back", "cancel", etc.), we implemented Ember actions
that perform these actions on your tour automatically. To use them, simply include
in the buttons array in each step.`,
},
{
attachTo: {
element: '.disable-scroll-element',
on: 'top',
},
buttons: [builtInButtons.cancel, builtInButtons.back, builtInButtons.next],
classes: 'custom-class-name-1 custom-class-name-2',
id: 'disableScroll',
text: `
<p>
When navigating the user through a tour, you may want to disable scrolling, so they
cannot mess up your carefully planned out, amazing tour. This is now easily achieved
with this.tour.set('disableScroll', true).
</p>
<p>
Try scrolling right now, then exit the tour and see that you can again!
</p>`,
},
{
buttons: [builtInButtons.cancel, builtInButtons.back],
id: 'noAttachTo',
title: 'Centered Modals',
classes: 'custom-class-name-1 custom-class-name-2',
text: 'If no attachTo is specified, the modal will appear in the center of the screen, as per the Shepherd docs.',
},
];
================================================
FILE: test-app/tests/helpers/index.js
================================================
import {
setupApplicationTest as upstreamSetupApplicationTest,
setupRenderingTest as upstreamSetupRenderingTest,
setupTest as upstreamSetupTest,
} from 'ember-qunit';
// This file exists to provide wrappers around ember-qunit's
// test setup functions. This way, you can easily extend the setup that is
// needed per test type.
function setupApplicationTest(hooks, options) {
upstreamSetupApplicationTest(hooks, options);
// Additional setup for application tests can be done here.
//
// For example, if you need an authenticated session for each
// application test, you could do:
//
// hooks.beforeEach(async function () {
// await authenticateSession(); // ember-simple-auth
// });
//
// This is also a good place to call test setup functions coming
// from other addons:
//
// setupIntl(hooks, 'en-us'); // ember-intl
// setupMirage(hooks); // ember-cli-mirage
}
function setupRenderingTest(hooks, options) {
upstreamSetupRenderingTest(hooks, options);
// Additional setup for rendering tests can be done here.
}
function setupTest(hooks, options) {
upstreamSetupTest(hooks, options);
// Additional setup for unit tests can be done here.
}
export { setupApplicationTest, setupRenderingTest, setupTest };
================================================
FILE: test-app/tests/helpers/index.ts
================================================
import {
setupApplicationTest as upstreamSetupApplicationTest,
setupRenderingTest as upstreamSetupRenderingTest,
setupTest as upstreamSetupTest,
type SetupTestOptions,
} from 'ember-qunit';
// This file exists to provide wrappers around ember-qunit's
// test setup functions. This way, you can easily extend the setup that is
// needed per test type.
function setupApplicationTest(hooks: NestedHooks, options?: SetupTestOptions) {
upstreamSetupApplicationTest(hooks, options);
// Additional setup for application tests can be done here.
//
// For example, if you need an authenticated session for each
// application test, you could do:
//
// hooks.beforeEach(async function () {
// await authenticateSession(); // ember-simple-auth
// });
//
// This is also a good place to call test setup functions coming
// from other addons:
//
// setupIntl(hooks, 'en-us'); // ember-intl
// setupMirage(hooks); // ember-cli-mirage
}
function setupRenderingTest(hooks: NestedHooks, options?: SetupTestOptions) {
upstreamSetupRenderingTest(hooks, options);
// Additional setup for rendering tests can be done here.
}
function setupTest(hooks: NestedHooks, options?: SetupTestOptions) {
upstreamSetupTest(hooks, options);
// Additional setup for unit tests can be done here.
}
export { setupApplicationTest, setupRenderingTest, setupTest };
================================================
FILE: test-app/tests/index.html
================================================
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Dummy Tests</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
{{content-for "head"}}
{{content-for "test-head"}}
<link rel="stylesheet" href="{{rootURL}}assets/vendor.css">
<link rel="stylesheet" href="{{rootURL}}assets/test-app.css">
<link rel="stylesheet" href="{{rootURL}}assets/test-support.css">
{{content-for "head-footer"}}
{{content-for "test-head-footer"}}
</head>
<body>
{{content-for "body"}}
{{content-for "test-body"}}
<div id="qunit"></div>
<div id="qunit-fixture">
<div id="ember-testing-container">
<div id="ember-testing"></div>
</div>
</div>
<script src="/testem.js" integrity="" data-embroider-ignore></script>
<script src="{{rootURL}}assets/vendor.js"></script>
<script src="{{rootURL}}assets/test-support.js"></script>
<script src="{{rootURL}}assets/test-app.js"></script>
<script src="{{rootURL}}assets/tests.js"></script>
{{content-for "body-footer"}}
{{content-for "test-body-footer"}}
</body>
</html>
================================================
FILE: test-app/tests/integration/.gitkeep
================================================
================================================
FILE: test-app/tests/test-helper.js
================================================
import Application from 'test-app/app';
import config from 'test-app/config/environment';
import * as QUnit from 'qunit';
import { setApplication } from '@ember/test-helpers';
import { setup } from 'qunit-dom';
import { start } from 'ember-qunit';
setApplication(Application.create(config.APP));
setup(QUnit.assert);
start();
================================================
FILE: test-app/tests/test-helper.ts
================================================
import Application from 'test-app/app';
import config from 'test-app/config/environment';
import * as QUnit from 'qunit';
import { setApplication } from '@ember/test-helpers';
import { setup } from 'qunit-dom';
import { loadTests } from 'ember-qunit/test-loader';
import { start, setupEmberOnerrorValidation } from 'ember-qunit';
setApplication(Application.create(config.APP));
setup(QUnit.assert);
setupEmberOnerrorValidation();
loadTests();
start();
================================================
FILE: test-app/tests/unit/.gitkeep
================================================
================================================
FILE: test-app/tests/unit/services/tour-test.js
================================================
/* eslint-disable ember/no-runloop */
import { module, test } from 'qunit';
import { setupTest } from 'ember-qunit';
import EmberObject from '@ember/object';
import { run } from '@ember/runloop';
import { builtInButtons } from '../../data';
const steps = [
{
id: 'intro',
options: {
attachTo: {
element: '.test-element',
on: 'bottom',
},
buttons: [builtInButtons.cancel, builtInButtons.next],
classes: 'custom-class-name-1 custom-class-name-2',
title: 'Welcome to Ember-Shepherd!',
text: 'Test text',
scrollTo: true,
scrollToHandler() {
return 'custom scrollToHandler';
},
},
},
];
module('Unit | Service | tour', function (hooks) {
setupTest(hooks);
test('it starts the tour when the `start` event is triggered', function (assert) {
class mockTourObject extends EmberObject {
start() {
assert.ok(true, 'The tour was started');
}
}
const service = this.owner.factoryFor('service:tour').create({
steps,
});
service.set('tourObject', mockTourObject.create());
run(function () {
service.start();
});
});
test('it allows another object to bind to events', function (assert) {
class mockTourObject extends EmberObject {
next() {}
}
const service = this.owner.factoryFor('service:tour').create({
steps,
});
service.set('tourObject', mockTourObject.create());
service.on('next', function () {
assert.ok(true);
});
run(function () {
service.next();
});
});
test('it passes through a custom scrollToHandler option', function (assert) {
class mockTourObject extends EmberObject {
start() {
assert.strictEqual(
steps[0].options.scrollToHandler(),
'custom scrollToHandler',
'The handler was passed through as an option on the step',
);
}
}
const service = this.owner.factoryFor('service:tour').create({
steps,
});
service.set('tourObject', mockTourObject.create());
run(function () {
service.start();
});
});
});
================================================
FILE: test-app/tests/unit/utils/make-button-test.js
================================================
import { makeButton } from 'ember-shepherd/utils/buttons';
import { module, test } from 'qunit';
module('Unit | Utility | make-button', function () {
module('Making an `action` handler for Shepherd button types', function () {
test('returning an object with an `action` handler if a supported built-in button "type" is specified', async function (assert) {
const context = {
next() {
assert.ok(true, 'Action was called in calling context');
},
};
const buttonOpts = {
type: 'next',
classes: 'foo',
text: 'Suivant!',
};
const button = makeButton.call(context, buttonOpts);
assert.strictEqual(button.classes, buttonOpts.classes);
assert.strictEqual(button.text, buttonOpts.text);
button.action();
});
test('Throwing an error if the built-in button "type" specified is not supported', async function (assert) {
const badButtonOpts = {
type: 'cipher',
classes: 'foo',
text: 'Encrypt',
};
const goodButtonOpts = {
type: 'next',
classes: 'foo',
text: 'Encrypt',
};
assert.throws(() => makeButton(badButtonOpts));
assert.strictEqual(makeButton(goodButtonOpts).text, goodButtonOpts.text);
assert.strictEqual(
makeButton(goodButtonOpts).classes,
goodButtonOpts.classes,
);
});
});
});
================================================
FILE: test-app/tsconfig.json
================================================
{
"extends": "@tsconfig/ember/tsconfig.json",
"glint": {
"environment": ["ember-loose", "ember-template-imports"]
},
"compilerOptions": {
"skipLibCheck": true,
"noEmit": true,
"noEmitOnError": false,
"declaration": false,
"declarationMap": false,
// The combination of `baseUrl` with `paths` allows Ember's classic package
// layout, which is not resolvable with the Node resolution algorithm, to
// work with TypeScript.
"baseUrl": ".",
"paths": {
"test-app/tests/*": ["tests/*"],
"test-app/*": ["app/*"],
"*": ["types/*"]
},
"types": ["ember-source/types"]
}
}
================================================
FILE: test-app/types/global.d.ts
================================================
import '@glint/environment-ember-loose';
gitextract_y9qvqvon/
├── .editorconfig
├── .github/
│ ├── dependabot.yml
│ └── workflows/
│ ├── addon-docs.yml
│ ├── ci.yml
│ ├── plan-release.yml
│ ├── publish.yml
│ └── push-dist.yml
├── .gitignore
├── .npmrc
├── .prettierignore
├── .prettierrc.cjs
├── .release-plan.json
├── .tool-versions
├── CHANGELOG.md
├── CONTRIBUTING.md
├── LICENSE.md
├── README.md
├── RELEASE.md
├── config/
│ └── ember-cli-update.json
├── ember-shepherd/
│ ├── .gitignore
│ ├── .prettierignore
│ ├── .prettierrc.cjs
│ ├── .template-lintrc.cjs
│ ├── addon-main.cjs
│ ├── babel.config.json
│ ├── eslint.config.mjs
│ ├── package.json
│ ├── rollup.config.mjs
│ ├── src/
│ │ ├── .gitkeep
│ │ ├── index.ts
│ │ ├── services/
│ │ │ └── tour.ts
│ │ ├── template-registry.ts
│ │ ├── unpublished-development-types/
│ │ │ └── index.d.ts
│ │ └── utils/
│ │ ├── buttons.ts
│ │ └── dom.ts
│ ├── tsconfig.json
│ └── unpublished-development-types/
│ └── index.d.ts
├── package.json
├── pnpm-workspace.yaml
└── test-app/
├── .editorconfig
├── .ember-cli
├── .gitignore
├── .prettierignore
├── .prettierrc.js
├── .stylelintignore
├── .stylelintrc.js
├── .template-lintrc.js
├── .watchmanconfig
├── README.md
├── app/
│ ├── app.ts
│ ├── components/
│ │ └── .gitkeep
│ ├── config/
│ │ └── environment.d.ts
│ ├── controllers/
│ │ ├── .gitkeep
│ │ └── docs/
│ │ └── demo.js
│ ├── data.js
│ ├── deprecation-workflow.ts
│ ├── helpers/
│ │ └── .gitkeep
│ ├── index.html
│ ├── models/
│ │ └── .gitkeep
│ ├── router.js
│ ├── routes/
│ │ ├── .gitkeep
│ │ └── docs/
│ │ └── demo.js
│ ├── styles/
│ │ ├── app.css
│ │ ├── fonts.css
│ │ └── shepherd-theme.css
│ └── templates/
│ ├── application.hbs
│ ├── docs/
│ │ ├── demo.hbs
│ │ ├── faq.md
│ │ ├── index.md
│ │ ├── not-found.hbs
│ │ └── usage.md
│ ├── docs.hbs
│ └── index.hbs
├── config/
│ ├── addon-docs.js
│ ├── deploy.js
│ ├── ember-cli-update.json
│ ├── ember-try.js
│ ├── environment.js
│ ├── optional-features.json
│ └── targets.js
├── ember-cli-build.js
├── eslint.config.mjs
├── package.json
├── public/
│ ├── crossdomain.xml
│ └── robots.txt
├── testem.js
├── tests/
│ ├── acceptance/
│ │ └── ember-shepherd-test.js
│ ├── data.js
│ ├── helpers/
│ │ ├── index.js
│ │ └── index.ts
│ ├── index.html
│ ├── integration/
│ │ └── .gitkeep
│ ├── test-helper.js
│ ├── test-helper.ts
│ └── unit/
│ ├── .gitkeep
│ ├── services/
│ │ └── tour-test.js
│ └── utils/
│ └── make-button-test.js
├── tsconfig.json
└── types/
└── global.d.ts
SYMBOL INDEX (43 symbols across 11 files)
FILE: ember-shepherd/src/services/tour.ts
type EmberShepherdStepOptions (line 16) | interface EmberShepherdStepOptions extends Omit<StepOptions, 'buttons'> {
class TourService (line 41) | class TourService extends Service.extend(Evented) {
method constructor (line 207) | constructor(owner: Owner) {
method addSteps (line 280) | addSteps(steps: Array<EmberShepherdStepOptions>) {
method back (line 321) | back() {
method cancel (line 334) | async cancel() {
method complete (line 344) | complete() {
method hide (line 354) | hide() {
method next (line 364) | next() {
method show (line 378) | show(id: string) {
method start (line 388) | async start() {
method _onTourStart (line 405) | _onTourStart() {
method _onTourFinish (line 418) | _onTourFinish(completeOrCancel: 'complete' | 'cancel') {
method _initialize (line 433) | _initialize() {
method _requiredElementsPresent (line 489) | _requiredElementsPresent() {
FILE: ember-shepherd/src/utils/buttons.ts
type EmberShepherdButton (line 9) | type EmberShepherdButton = StepOptionsButton & {
function makeButton (line 25) | function makeButton(
FILE: ember-shepherd/src/utils/dom.ts
function elementIsHidden (line 9) | function elementIsHidden(element: HTMLElement) {
FILE: test-app/app/app.ts
class App (line 12) | class App extends Application {
FILE: test-app/app/controllers/docs/demo.js
class DocsDemoController (line 6) | class DocsDemoController extends Controller {
method toggleHelpModal (line 23) | @action
method toggleHelpNonmodal (line 30) | @action
FILE: test-app/app/routes/docs/demo.js
class DocsDemoRoute (line 7) | class DocsDemoRoute extends Route {
method beforeModel (line 12) | async beforeModel() {
method model (line 27) | model() {
method activate (line 49) | activate() {
method _startTour (line 56) | _startTour() {
FILE: test-app/tests/acceptance/ember-shepherd-test.js
method action (line 222) | action() {
method scrollToHandler (line 300) | scrollToHandler() {
FILE: test-app/tests/helpers/index.js
function setupApplicationTest (line 11) | function setupApplicationTest(hooks, options) {
function setupRenderingTest (line 30) | function setupRenderingTest(hooks, options) {
function setupTest (line 36) | function setupTest(hooks, options) {
FILE: test-app/tests/helpers/index.ts
function setupApplicationTest (line 12) | function setupApplicationTest(hooks: NestedHooks, options?: SetupTestOpt...
function setupRenderingTest (line 31) | function setupRenderingTest(hooks: NestedHooks, options?: SetupTestOptio...
function setupTest (line 37) | function setupTest(hooks: NestedHooks, options?: SetupTestOptions) {
FILE: test-app/tests/unit/services/tour-test.js
method scrollToHandler (line 21) | scrollToHandler() {
class mockTourObject (line 32) | class mockTourObject extends EmberObject {
method start (line 33) | start() {
method next (line 51) | next() {}
method start (line 71) | start() {
class mockTourObject (line 50) | class mockTourObject extends EmberObject {
method start (line 33) | start() {
method next (line 51) | next() {}
method start (line 71) | start() {
class mockTourObject (line 70) | class mockTourObject extends EmberObject {
method start (line 33) | start() {
method next (line 51) | next() {}
method start (line 71) | start() {
FILE: test-app/tests/unit/utils/make-button-test.js
method next (line 8) | next() {
Condensed preview — 99 files, each showing path, character count, and a content snippet. Download the .json file or copy for the full structured content (195K chars).
[
{
"path": ".editorconfig",
"chars": 367,
"preview": "# EditorConfig helps developers define and maintain consistent\n# coding styles between different editors and IDEs\n# edit"
},
{
"path": ".github/dependabot.yml",
"chars": 237,
"preview": "version: 2\nupdates:\n- package-ecosystem: npm\n directory: \"/\"\n schedule:\n interval: daily\n time: \"10:00\"\n open-p"
},
{
"path": ".github/workflows/addon-docs.yml",
"chars": 1435,
"preview": "name: Publish Addon Docs\n\non:\n push:\n branches:\n - main\n - master\n tags:\n - \"**\"\njobs:\n build:\n "
},
{
"path": ".github/workflows/ci.yml",
"chars": 1931,
"preview": "name: CI\n\non:\n push:\n branches:\n - main\n - master\n pull_request: {}\n\nconcurrency:\n group: ci-${{ github."
},
{
"path": ".github/workflows/plan-release.yml",
"chars": 2011,
"preview": "name: Plan Release\non:\n workflow_dispatch:\n push:\n branches:\n - main\n - master\n pull_request_target: # T"
},
{
"path": ".github/workflows/publish.yml",
"chars": 1064,
"preview": "# For every push to the primary branch with .release-plan.json modified,\n# runs release-plan.\n\nname: Publish Stable\n\non:"
},
{
"path": ".github/workflows/push-dist.yml",
"chars": 971,
"preview": "# Because this library needs to be built,\n# we can't easily point package.json files at the git repo for easy cross-repo"
},
{
"path": ".gitignore",
"chars": 376,
"preview": "# See https://help.github.com/ignore-files/ for more about ignoring files.\n\n# dependencies\nnode_modules/\n\n# misc\n.env*\n."
},
{
"path": ".npmrc",
"chars": 612,
"preview": "####################\n# super strict mode\n####################\nauto-install-peers=false\nstrict-peer-dependents=true\nresol"
},
{
"path": ".prettierignore",
"chars": 208,
"preview": "# Prettier is also run from each package, so the ignores here\n# protect against files that may not be within a package\n\n"
},
{
"path": ".prettierrc.cjs",
"chars": 109,
"preview": "'use strict';\n\nmodule.exports = {\n plugins: ['prettier-plugin-ember-template-tag'],\n singleQuote: true,\n};\n"
},
{
"path": ".release-plan.json",
"chars": 1700,
"preview": "{\n \"solution\": {\n \"ember-shepherd\": {\n \"impact\": \"major\",\n \"oldVersion\": \"17.3.1\",\n \"newVersion\": \"18"
},
{
"path": ".tool-versions",
"chars": 28,
"preview": "nodejs 20.20.0\npnpm 10.28.0\n"
},
{
"path": "CHANGELOG.md",
"chars": 17296,
"preview": "# Changelog\n\n## Release (2026-02-16)\n\n* ember-shepherd 18.0.0 (major)\n\n#### :boom: Breaking Change\n* `ember-shepherd`\n "
},
{
"path": "CONTRIBUTING.md",
"chars": 635,
"preview": "# How To Contribute\n\n## Installation\n\n- `git clone <repository-url>`\n- `cd ember-shepherd`\n- `pnpm install`\n\n## Linting\n"
},
{
"path": "LICENSE.md",
"chars": 36916,
"preview": "# Shepherd.js License\n\nShepherd.js is dual-licensed under **AGPL-3.0** (for open source and non-commercial use) and a **"
},
{
"path": "README.md",
"chars": 1746,
"preview": "# ember-shepherd\n\n<a href=\"https://shipshape.io/\"><img src=\"http://i.imgur.com/DWHQjA5.png\" alt=\"Ship Shape\" width=\"100\""
},
{
"path": "RELEASE.md",
"chars": 1618,
"preview": "# Release Process\n\nReleases in this repo are mostly automated using [release-plan](https://github.com/embroider-build/re"
},
{
"path": "config/ember-cli-update.json",
"chars": 422,
"preview": "{\n \"schemaVersion\": \"1.0.0\",\n \"projectName\": \"ember-shepherd\",\n \"packages\": [\n {\n \"name\": \"@embroider/addon-b"
},
{
"path": "ember-shepherd/.gitignore",
"chars": 360,
"preview": "# The authoritative copies of these live in the monorepo root (because they're\n# more useful on github that way), but th"
},
{
"path": "ember-shepherd/.prettierignore",
"chars": 101,
"preview": "# unconventional js\n/blueprints/*/files/\n\n# compiled output\n/dist/\n/declarations/\n\n# misc\n/coverage/\n"
},
{
"path": "ember-shepherd/.prettierrc.cjs",
"chars": 260,
"preview": "'use strict';\n\nmodule.exports = {\n plugins: ['prettier-plugin-ember-template-tag'],\n overrides: [\n {\n files: '"
},
{
"path": "ember-shepherd/.template-lintrc.cjs",
"chars": 63,
"preview": "'use strict';\n\nmodule.exports = {\n extends: 'recommended',\n};\n"
},
{
"path": "ember-shepherd/addon-main.cjs",
"chars": 114,
"preview": "'use strict';\n\nconst { addonV1Shim } = require('@embroider/addon-shim');\nmodule.exports = addonV1Shim(__dirname);\n"
},
{
"path": "ember-shepherd/babel.config.json",
"chars": 505,
"preview": "{\n \"plugins\": [\n [\n \"@babel/plugin-transform-typescript\",\n {\n \"allExtensions\": true,\n \"onlyR"
},
{
"path": "ember-shepherd/eslint.config.mjs",
"chars": 2702,
"preview": "/**\n * Debugging:\n * https://eslint.org/docs/latest/use/configure/debug\n * ------------------------------------------"
},
{
"path": "ember-shepherd/package.json",
"chars": 3231,
"preview": "{\n \"name\": \"ember-shepherd\",\n \"version\": \"18.0.0\",\n \"description\": \"An Ember wrapper for the site tour library Shephe"
},
{
"path": "ember-shepherd/rollup.config.mjs",
"chars": 2666,
"preview": "import { babel } from '@rollup/plugin-babel';\nimport copy from 'rollup-plugin-copy';\nimport { Addon } from '@embroider/a"
},
{
"path": "ember-shepherd/src/.gitkeep",
"chars": 0,
"preview": ""
},
{
"path": "ember-shepherd/src/index.ts",
"chars": 0,
"preview": ""
},
{
"path": "ember-shepherd/src/services/tour.ts",
"chars": 13960,
"preview": "/* eslint-disable ember/no-runloop */\nimport { isEmpty, isPresent } from '@ember/utils';\nimport Service from '@ember/ser"
},
{
"path": "ember-shepherd/src/template-registry.ts",
"chars": 508,
"preview": "// Easily allow apps, which are not yet using strict mode templates, to consume your Glint types, by importing this file"
},
{
"path": "ember-shepherd/src/unpublished-development-types/index.d.ts",
"chars": 255,
"preview": "// Add any types here that you need for local development only.\n// These will *not* be published as part of your addon, "
},
{
"path": "ember-shepherd/src/utils/buttons.ts",
"chars": 1370,
"preview": "/* eslint-disable ember/no-runloop */\nimport { bind } from '@ember/runloop';\nimport { assert } from '@ember/debug';\n\nimp"
},
{
"path": "ember-shepherd/src/utils/dom.ts",
"chars": 383,
"preview": "/**\n * Helper method to check if element is hidden, since we cannot use :visible without jQuery\n *\n * @function elementI"
},
{
"path": "ember-shepherd/tsconfig.json",
"chars": 740,
"preview": "{\n \"extends\": \"@ember/library-tsconfig\",\n \"include\": [\"src/**/*\", \"unpublished-development-types/**/*\"],\n \"glint\": {\n"
},
{
"path": "ember-shepherd/unpublished-development-types/index.d.ts",
"chars": 663,
"preview": "// Add any types here that you need for local development only.\n// These will *not* be published as part of your addon, "
},
{
"path": "package.json",
"chars": 997,
"preview": "{\n \"version\": \"17.3.1\",\n \"private\": true,\n \"repository\": \"https://github.com/RobbieTheWagner/ember-shepherd\",\n \"lice"
},
{
"path": "pnpm-workspace.yaml",
"chars": 123,
"preview": "packages:\n - ember-shepherd\n - test-app\n\nonlyBuiltDependencies:\n - '@parcel/watcher'\n - core-js\n - ember-modal-dial"
},
{
"path": "test-app/.editorconfig",
"chars": 367,
"preview": "# EditorConfig helps developers define and maintain consistent\n# coding styles between different editors and IDEs\n# edit"
},
{
"path": "test-app/.ember-cli",
"chars": 699,
"preview": "{\n /**\n Setting `isTypeScriptProject` to true will force the blueprint generators to generate TypeScript\n rather "
},
{
"path": "test-app/.gitignore",
"chars": 224,
"preview": "# compiled output\n/dist/\n/declarations/\n\n# dependencies\n/node_modules/\n\n# misc\n/.env*\n/.pnp*\n/.eslintcache\n/coverage/\n/n"
},
{
"path": "test-app/.prettierignore",
"chars": 139,
"preview": "# unconventional js\n/blueprints/*/files/\n\n# compiled output\n/dist/\n\n# misc\n/coverage/\n!.*\n.*/\n/pnpm-lock.yaml\nember-cli-"
},
{
"path": "test-app/.prettierrc.js",
"chars": 260,
"preview": "'use strict';\n\nmodule.exports = {\n plugins: ['prettier-plugin-ember-template-tag'],\n overrides: [\n {\n files: '"
},
{
"path": "test-app/.stylelintignore",
"chars": 70,
"preview": "# unconventional files\n/blueprints/*/files/\n\n# compiled output\n/dist/\n"
},
{
"path": "test-app/.stylelintrc.js",
"chars": 184,
"preview": "'use strict';\n\nmodule.exports = {\n extends: ['stylelint-config-standard'],\n rules: {\n 'color-hex-length': null,\n "
},
{
"path": "test-app/.template-lintrc.js",
"chars": 63,
"preview": "'use strict';\n\nmodule.exports = {\n extends: 'recommended',\n};\n"
},
{
"path": "test-app/.watchmanconfig",
"chars": 30,
"preview": "{\n \"ignore_dirs\": [\"dist\"]\n}\n"
},
{
"path": "test-app/README.md",
"chars": 1446,
"preview": "# test-app\n\nThis README outlines the details of collaborating on this Ember application.\nA short introduction of this ap"
},
{
"path": "test-app/app/app.ts",
"chars": 592,
"preview": "import '@warp-drive/ember/install';\nimport Application from '@ember/application';\nimport Resolver from 'ember-resolver';"
},
{
"path": "test-app/app/components/.gitkeep",
"chars": 0,
"preview": ""
},
{
"path": "test-app/app/config/environment.d.ts",
"chars": 309,
"preview": "/**\n * Type declarations for\n * import config from 'test-app/config/environment'\n */\ndeclare const config: {\n enviro"
},
{
"path": "test-app/app/controllers/.gitkeep",
"chars": 0,
"preview": ""
},
{
"path": "test-app/app/controllers/docs/demo.js",
"chars": 880,
"preview": "import Controller from '@ember/controller';\nimport { action } from '@ember/object';\nimport { inject as service } from '@"
},
{
"path": "test-app/app/data.js",
"chars": 4018,
"preview": "export const builtInButtons = {\n cancel: {\n classes: 'cancel-button',\n secondary: true,\n text: 'Exit',\n typ"
},
{
"path": "test-app/app/deprecation-workflow.ts",
"chars": 740,
"preview": "import setupDeprecationWorkflow from 'ember-cli-deprecation-workflow';\n\n/**\n * Docs: https://github.com/ember-cli/ember-"
},
{
"path": "test-app/app/helpers/.gitkeep",
"chars": 0,
"preview": ""
},
{
"path": "test-app/app/index.html",
"chars": 641,
"preview": "<!DOCTYPE html>\n<html>\n <head>\n <meta charset=\"utf-8\">\n <title>Ember Shepherd</title>\n <meta name=\"description"
},
{
"path": "test-app/app/models/.gitkeep",
"chars": 0,
"preview": ""
},
{
"path": "test-app/app/router.js",
"chars": 478,
"preview": "import AddonDocsRouter, { docsRoute } from 'ember-cli-addon-docs/router';\nimport config from 'test-app/config/environmen"
},
{
"path": "test-app/app/routes/.gitkeep",
"chars": 0,
"preview": ""
},
{
"path": "test-app/app/routes/docs/demo.js",
"chars": 1372,
"preview": "import Route from '@ember/routing/route';\nimport config from '../../config/environment';\nimport { inject as service } fr"
},
{
"path": "test-app/app/styles/app.css",
"chars": 1616,
"preview": "@import url(\"https://cdn.jsdelivr.net/npm/shepherd.js@14.3.0/dist/css/shepherd.min.css\");\n@import url(\"./fonts.css\");\n@i"
},
{
"path": "test-app/app/styles/fonts.css",
"chars": 504,
"preview": "@import url(\"https://fonts.googleapis.com/css?family=Pacifico\");\n\n@font-face {\n font-family: \"GT Pressura\";\n src:\n "
},
{
"path": "test-app/app/styles/shepherd-theme.css",
"chars": 3670,
"preview": ".shepherd-logo {\n height: auto;\n width: 217px;\n}\n\n.shepherd-logo .lines,\n.shepherd-logo .open-eye,\n.shepherd-logo .win"
},
{
"path": "test-app/app/templates/application.hbs",
"chars": 91,
"preview": "<div class=\"ember-view\">\n <DocsHeader />\n\n {{outlet}}\n\n <DocsKeyboardShortcuts />\n</div>"
},
{
"path": "test-app/app/templates/docs/demo.hbs",
"chars": 23475,
"preview": "{{! template-lint-disable }}\n<div class=\"demo-page\">\n <div class=\"docs-w-full\">\n <div class=\"docs-flex docs-justify-"
},
{
"path": "test-app/app/templates/docs/faq.md",
"chars": 871,
"preview": "## Q/A\n\n### Q: Woah, events? How does that work with buttons?\n\nA: Don't worry, it's not too bad! You can just set up an "
},
{
"path": "test-app/app/templates/docs/index.md",
"chars": 913,
"preview": "# ember-shepherd\n\n<a href=\"https://shipshape.io/\"><img src=\"http://i.imgur.com/DWHQjA5.png\" alt=\"Ship Shape\" width=\"100\""
},
{
"path": "test-app/app/templates/docs/not-found.hbs",
"chars": 133,
"preview": "<div class=\"docs-container\">\n <h1>Not found</h1>\n <p>This page doesn't exist. <LinkTo @route=\"index\">Head home?</LinkT"
},
{
"path": "test-app/app/templates/docs/usage.md",
"chars": 975,
"preview": "## Usage\n\nThe styles are no longer automatically added for Shepherd. You will need to add them to your styles manually. "
},
{
"path": "test-app/app/templates/docs.hbs",
"chars": 541,
"preview": "<DocsViewer as |viewer|>\n <viewer.nav as |nav|>\n <nav.section @label=\"Introduction\" />\n <nav.item @label=\"Introdu"
},
{
"path": "test-app/app/templates/index.hbs",
"chars": 1626,
"preview": "<section class=\"hero docs-flex docs-flex-wrap docs-justify-center\">\n <div class=\"section-content docs-mt-8 docs-mb-8 do"
},
{
"path": "test-app/config/addon-docs.js",
"chars": 290,
"preview": "/* eslint-env node */\n'use strict';\n\nconst AddonDocsConfig = require('ember-cli-addon-docs/lib/config');\n\nmodule.exports"
},
{
"path": "test-app/config/deploy.js",
"chars": 829,
"preview": "'use strict';\n\nmodule.exports = function (deployTarget) {\n let ENV = {\n build: {},\n // include other plugin confi"
},
{
"path": "test-app/config/ember-cli-update.json",
"chars": 448,
"preview": "{\n \"schemaVersion\": \"1.0.0\",\n \"packages\": [\n {\n \"name\": \"@ember-tooling/classic-build-app-blueprint\",\n \"v"
},
{
"path": "test-app/config/ember-try.js",
"chars": 1330,
"preview": "'use strict';\n\nconst getChannelURL = require('ember-source-channel-url');\nconst { embroiderSafe, embroiderOptimized } = "
},
{
"path": "test-app/config/environment.js",
"chars": 1226,
"preview": "'use strict';\n\nmodule.exports = function (environment) {\n const ENV = {\n modulePrefix: 'test-app',\n environment,\n"
},
{
"path": "test-app/config/optional-features.json",
"chars": 189,
"preview": "{\n \"application-template-wrapper\": false,\n \"default-async-observers\": true,\n \"jquery-integration\": false,\n \"template"
},
{
"path": "test-app/config/targets.js",
"chars": 157,
"preview": "'use strict';\n\nconst browsers = [\n 'last 1 Chrome versions',\n 'last 1 Firefox versions',\n 'last 1 Safari versions',\n]"
},
{
"path": "test-app/ember-cli-build.js",
"chars": 1312,
"preview": "'use strict';\n\nconst EmberApp = require('ember-cli/lib/broccoli/ember-app');\n// const { Webpack } = require('@embroider/"
},
{
"path": "test-app/eslint.config.mjs",
"chars": 3122,
"preview": "/**\n * Debugging:\n * https://eslint.org/docs/latest/use/configure/debug\n * ------------------------------------------"
},
{
"path": "test-app/package.json",
"chars": 4133,
"preview": "{\n \"name\": \"test-app\",\n \"version\": \"0.0.0\",\n \"private\": true,\n \"description\": \"Test app for ember-shepherd addon\",\n "
},
{
"path": "test-app/public/crossdomain.xml",
"chars": 585,
"preview": "<?xml version=\"1.0\"?>\n<!DOCTYPE cross-domain-policy SYSTEM \"http://www.adobe.com/xml/dtds/cross-domain-policy.dtd\">\n<cro"
},
{
"path": "test-app/public/robots.txt",
"chars": 51,
"preview": "# http://www.robotstxt.org\nUser-agent: *\nDisallow:\n"
},
{
"path": "test-app/testem.js",
"chars": 589,
"preview": "'use strict';\n\nmodule.exports = {\n test_page: 'tests/index.html?hidepassed',\n disable_watching: true,\n launch_in_ci: "
},
{
"path": "test-app/tests/acceptance/ember-shepherd-test.js",
"chars": 10006,
"preview": "import { module, test } from 'qunit';\nimport { visit, click, find } from '@ember/test-helpers';\nimport { setupApplicatio"
},
{
"path": "test-app/tests/data.js",
"chars": 4040,
"preview": "export const builtInButtons = {\n cancel: {\n classes: 'cancel-button',\n secondary: true,\n text: 'Exit',\n typ"
},
{
"path": "test-app/tests/helpers/index.js",
"chars": 1262,
"preview": "import {\n setupApplicationTest as upstreamSetupApplicationTest,\n setupRenderingTest as upstreamSetupRenderingTest,\n s"
},
{
"path": "test-app/tests/helpers/index.ts",
"chars": 1383,
"preview": "import {\n setupApplicationTest as upstreamSetupApplicationTest,\n setupRenderingTest as upstreamSetupRenderingTest,\n s"
},
{
"path": "test-app/tests/index.html",
"chars": 1176,
"preview": "<!DOCTYPE html>\n<html>\n <head>\n <meta charset=\"utf-8\">\n <title>Dummy Tests</title>\n <meta name=\"description\" c"
},
{
"path": "test-app/tests/integration/.gitkeep",
"chars": 0,
"preview": ""
},
{
"path": "test-app/tests/test-helper.js",
"chars": 329,
"preview": "import Application from 'test-app/app';\nimport config from 'test-app/config/environment';\nimport * as QUnit from 'qunit'"
},
{
"path": "test-app/tests/test-helper.ts",
"chars": 454,
"preview": "import Application from 'test-app/app';\nimport config from 'test-app/config/environment';\nimport * as QUnit from 'qunit'"
},
{
"path": "test-app/tests/unit/.gitkeep",
"chars": 0,
"preview": ""
},
{
"path": "test-app/tests/unit/services/tour-test.js",
"chars": 2142,
"preview": "/* eslint-disable ember/no-runloop */\nimport { module, test } from 'qunit';\nimport { setupTest } from 'ember-qunit';\nimp"
},
{
"path": "test-app/tests/unit/utils/make-button-test.js",
"chars": 1414,
"preview": "import { makeButton } from 'ember-shepherd/utils/buttons';\nimport { module, test } from 'qunit';\n\nmodule('Unit | Utility"
},
{
"path": "test-app/tsconfig.json",
"chars": 643,
"preview": "{\n \"extends\": \"@tsconfig/ember/tsconfig.json\",\n \"glint\": {\n \"environment\": [\"ember-loose\", \"ember-template-imports\""
},
{
"path": "test-app/types/global.d.ts",
"chars": 41,
"preview": "import '@glint/environment-ember-loose';\n"
}
]
About this extraction
This page contains the full source code of the shipshapecode/ember-shepherd GitHub repository, extracted and formatted as plain text for AI agents and large language models (LLMs). The extraction includes 99 files (178.5 KB), approximately 55.9k tokens, and a symbol index with 43 extracted functions, classes, methods, constants, and types. Use this with OpenClaw, Claude, ChatGPT, Cursor, Windsurf, or any other AI tool that accepts text input. You can copy the full output to your clipboard or download it as a .txt file.
Extracted by GitExtract — free GitHub repo to text converter for AI. Built by Nikandr Surkov.