{"_id":"@atlasling/readalong-syllabics","_rev":"2-bb2039c6e2393ef54971474d1903510f","name":"@atlasling/readalong-syllabics","dist-tags":{"latest":"1.1.0"},"versions":{"0.1.0":{"name":"@atlasling/readalong-syllabics","version":"0.1.0","description":"ReadAlong Web Component","main":"dist/index.js","module":"dist/index.mjs","es2015":"dist/esm/index.mjs","es2017":"dist/esm/index.mjs","types":"dist/types/components.d.ts","collection":"dist/collection/collection-manifest.json","collection:main":"dist/collection/index.js","unpkg":"dist/readalongs/readalongs.js","scripts":{"build":"stencil build --docs","start":"stencil build --dev --watch --serve","prepublish":"npm run build","test":"stencil test --spec --e2e","test.watch":"stencil test --spec --e2e --watchAll","generate":"stencil generate"},"dependencies":{"howler":"^2.2.0","rxjs":"^6.6.2"},"devDependencies":{"@stencil/core":"^1.17.3","@stencil/sass":"^1.3.2"},"license":"MIT","gitHead":"7dc8fce51863fc375f2f6d2082ab5ac709abfc3f","_id":"@atlasling/readalong-syllabics@0.1.0","_nodeVersion":"14.11.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-z1Yq/oVstNsheoitj8zD4cOGRTCVP2ppR0IpJuKPuDN6uqJTSfRE1bf40yyl6dxZUt8j2WUrlOQGjOOogcK9YQ==","shasum":"6d8c090076e8c632261a3b758b0de4dfce9838e1","tarball":"https://registry.npmjs.org/@atlasling/readalong-syllabics/-/readalong-syllabics-0.1.0.tgz","fileCount":71,"unpackedSize":1582372,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfYicgCRA9TVsSAnZWagAAVSkQAJf0jPGAvH4ds4CJlAxq\nHQfjsMQ6gmBhLU8KgzYypiRh59g5Lb62fQIZGNmQlJ+fZ8c3qvRIrTunHS/h\nP+a9/xHLwtmBiHn5xqygpbgZwj9enRmutXRf1NmNEd7w8KSXJvcK/QeMYCfV\ntC8p7twKfDypfBKryWWwtEyPrPf29t2IFK7U/dya/Q6H/q2xgrtENrXJ8qEK\nzX8R/jKBuE7prjEe3P/EU15ec+EAUDaK55OBSNbpcfof9xs8Z+7tvp+3GH9x\n8EAsJYmIjJFQuBV/XpMp2gob4IDRlBWoibVpc+qbb7xEQu0LpnM9AZLeumXk\niHnirEna4/f8wwHZLXfmURw2c/mqoqL8zUJHfHuxKsoxGxi2EL5XRZ4ABMsi\nkdQlB5bR59faEyVeBqCCpLl//Y4NF18EHg/huW9c/s0o3j5fM6ng5DHqelWf\nrA43ke4nZ8Y4lPVpnT2RfgXciN+yJvAH64YpezrEhsY92WJE4EZ0xujEwvBu\nPLOWFUAlZOk89lAH/Vr2lYrQiOxNnS5wyCGNs31y7QjwNI3hJ6QyqVWLkgEn\nsMmioxa/9Mu/G6ZDcRUC3ovSxll7XeXuGaivGRED3MqzY9Dgtg5XLU8nI2ud\nms65v58AViGs6mrbxaG0jui//kcjiNlNW+5VfMRRVR3yZNksKdJXhKp0RGg2\ndfej\r\n=CaAF\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCq3pFAfQb5/Vt5eWqeb0MbRmnRwstMGsk/eAETUObRrQIgRv/tNGo6IG8vFQ9cnstzi7yTpnS7PyDPxGsq7SXZH14="}]},"maintainers":[{"name":"atlasling","email":"algonquian.linguistic.atlas@gmail.com"}],"_npmUser":{"name":"atlasling","email":"algonquian.linguistic.atlas@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/readalong-syllabics_0.1.0_1600268064217_0.8393804884969509"},"_hasShrinkwrap":false},"1.1.0":{"name":"@atlasling/readalong-syllabics","version":"1.1.0","description":"ReadAlong Web Component with Syllabics support","main":"dist/index.js","module":"dist/index.js","es2015":"dist/esm/index.mjs","es2017":"dist/esm/index.mjs","types":"dist/types/components.d.ts","collection":"dist/collection/collection-manifest.json","collection:main":"dist/collection/index.js","unpkg":"dist/readalongs/readalongs.js","scripts":{"build":"stencil build --docs","start":"stencil build --dev --watch --serve","prepublish":"npm run build","test":"stencil test --spec --e2e","test.watch":"stencil test --spec --e2e --watchAll","generate":"stencil generate"},"dependencies":{"howler":"^2.2.0","rxjs":"^6.6.2"},"devDependencies":{"@stencil/core":"^1.17.3","@stencil/sass":"^1.3.2"},"license":"MIT","gitHead":"c2fbb5edc7a547dc82bec57878c7ec3d754bac04","_id":"@atlasling/readalong-syllabics@1.1.0","_nodeVersion":"14.11.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-OFNU2Sl+03nrieYbKnkytj7veVlLvTtVT8Jppql/r4PYaaLvT9yRiO4F8itDoy0a9BbArv3YpgUMUX7TKLl8sA==","shasum":"a1dff5f666b777bcbf97000559089d80a1291f4d","tarball":"https://registry.npmjs.org/@atlasling/readalong-syllabics/-/readalong-syllabics-1.1.0.tgz","fileCount":71,"unpackedSize":1583584,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfoXLNCRA9TVsSAnZWagAAtwQQAIbKSeomiC5n/AMdL/G2\nGU9tccIIJZVRpjDSQEYpmKmoA2JsJ/tdXfwoCAgVhEh8n53jfTFOC8BJTrS1\naaRzaekNy6C/2usStW9dDpj10t3Nsy15Us5oRELSTWWvyCrkbG0OGDKLC7eZ\nGIhwdr5l50NbOCAkpoCJ5T0I9pcl/UCe8T1d5mBmWpei91HoccfV65jUSpUX\nHQX6uB9PRoviZDXDyL6Dsior5XctZBscJakE+1uN8xqk1Yipy7RbVHPmFlAc\ndg5742bchoer6QB0KpvbHUdrNY9nT+mpPxQLjFCwo71uHg8xUE+3NOdGVktR\nb48T9jSxLyt8dRyF2mKPKx+UsVM0vOgtWZv59aIfFLC1bNhsd7UmgOcxpXN8\nMHh3Rrf70UyQlOkc8eYDPl5JCe5T0BgGnnnLoeQ33RwNbr4WGNteVA+n1cNU\nHSSeRMNU/i6EVPXdfI7QLsJc5cBhNu5k2L9JjU0f7kNOHwQMeOuxBvwYWUHz\nxS4UoXoscmPt8t8YuWhp+kjVfiec9ocbHSw24hsj+3vpFeW542wH8B8xPsst\n9kxa2S0OhZ2PHxAoLV7ysxk7idEBaGb/AG6S0eBQm2pGHN/RYXKs1DeM0oY4\nNYbwXqEo/WGqFT1WZgjVLZeafwR4aoFoWkCyJiXcCNrO/FlAotieDHZs9yHM\nUCmE\r\n=6WBw\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIDjWGEBhi1oCNTZ4dl6wRJtg2T9QAG+wDi21dTmDTzwfAiEAoFlo44meYCcEvPDOR8snPrX5jj0MNp7qPrsrn/hyLeE="}]},"_npmUser":{"name":"atlasling","email":"algonquian.linguistic.atlas@gmail.com"},"directories":{},"maintainers":[{"name":"atlasling","email":"algonquian.linguistic.atlas@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/readalong-syllabics_1.1.0_1604416204916_0.6450910732490216"},"_hasShrinkwrap":false}},"time":{"created":"2020-09-16T14:54:24.182Z","0.1.0":"2020-09-16T14:54:24.386Z","modified":"2022-04-04T16:11:58.350Z","1.1.0":"2020-11-03T15:10:05.185Z"},"maintainers":[{"name":"atlasling","email":"algonquian.linguistic.atlas@gmail.com"}],"description":"ReadAlong Web Component with Syllabics support","license":"MIT","readme":"\n\n# Read-Along Web Component\n\nThis is a web component for embedding read-along, audio/text aligned content in your website or hybrid app.\n\n## Installation\n\nFor now, just clone the repo, make sure you have node 6+, and run `npm install` from the project root. Then you can run `npm start` and a minimal website containing only the webcomponent will be served at `localhost:3333`. Any changes you make to `/src` will be automatically shown in the browser.\n\n## Properties\n\n| Property | Attribute | Description | Type | Default |\n| ----------- | ----------- | --------------------- | -------- | ----------- |\n| `alignment` | `alignment` | The alignment as SMIL | `string` | `undefined` |\n| `audio` | `audio` | The audio file | `string` | `undefined` |\n| `text` | `text` | The text as TEI | `string` | `undefined` |\n| `theme` | `theme` | The colour theme | `string` | `light` |\n\n\n## Test with your site\n\nYou can either modify the `/src/index.html` or after running `npm start` you can copy out the `www/build` folder and add the following script import in your own `index.html` page: \n\n```html\n\n\n```\n\nThen, you can add as many read-along components to your page as you like simply by adding `` elements with arguments for where to find your text, alignments and audio file. These files can be generated using _________ service located here: ____________.\n\n```html\n\n```\n\n## Theming\n\nThere are two themes out-of-the-box: `light` and `dark`. You set them as a property on the `` web component. If you want to add your own theme, it's as easy as adding your colour palette to the `$ui-themes` variable in `src/components/read-along-component/scss/utilities/_colors.scss`. Note you will have to rebuild the web component from source to do this, or submit your theme as a pull-request!\n\n```scss\n$ui-themes: (\n light: (\n primary: $white,\n secondary: darken($white, 50%),\n accent: darken($white, 60%),\n text: $black,\n text--secondary: $white,\n text--accent: $white,\n ),\n dark: (\n primary: lighten($black, 30%),\n secondary: darken($white, 35%),\n accent: $white,\n text: $white,\n text--secondary: $white,\n text--accent: $black\n )\n);\n```\n\n## Slots\n\nSlots allow you to add custom html into specific \"slots\" within the web component. For example, to add an optional header to the `\n Hello World!\n\n```\n\n| Slot | Description | Suggested Element |\n| ----------------------- | --------------------- | ----------------- |\n| `read-along-header` | The read along header | `span` |\n| `read-along-subheader` | Subheader (ie authors)| `span` |\n\n\n\n\n\n","readmeFilename":"readme.md"}