Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New package: mobile-top-nav #311

Merged
merged 4 commits into from
Oct 8, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions packages/mobile-top-nav/.eslintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"extends": ["plugin:lit/recommended", "../../.eslintrc.json"]
}
13 changes: 13 additions & 0 deletions packages/mobile-top-nav/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
/node_modules/

## testing
/coverage/

## temp folders
/.tmp/

# build
/_site/
/lib/

*.log
15 changes: 15 additions & 0 deletions packages/mobile-top-nav/.storybook/.babelrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"plugins": [
"@babel/plugin-syntax-dynamic-import",
"@babel/plugin-proposal-object-rest-spread"
],
"presets": [
[
"@babel/preset-env",
{
"useBuiltIns": "entry",
"corejs": "2",
}
]
]
}
7 changes: 7 additions & 0 deletions packages/mobile-top-nav/.storybook/addons.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import '@storybook/addon-a11y/register';
import '@storybook/addon-actions/register';
import '@storybook/addon-knobs/register';
import '@storybook/addon-notes/register';
import '@storybook/addon-links/register';
import '@storybook/addon-storysource/register';
import '@storybook/addon-viewport/register';
11 changes: 11 additions & 0 deletions packages/mobile-top-nav/.storybook/config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
import { configure, addDecorator } from '@storybook/polymer';
import { withA11y } from '@storybook/addon-a11y';
import '@storybook/addon-console';

const req = require.context('../stories', true, /\.stories\.js$/);
function loadStories() {
req.keys().forEach(filename => req(filename));
}

addDecorator(withA11y);
configure(loadStories, module);
5 changes: 5 additions & 0 deletions packages/mobile-top-nav/.storybook/webpack.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
const defaultConfig = require('@open-wc/demoing-storybook/default-storybook-webpack-config.js');

module.exports = ({ config }) => {
return defaultConfig({ config, transpilePackages: ['lit-html', 'lit-element', '@open-wc'] });
};
661 changes: 661 additions & 0 deletions packages/mobile-top-nav/LICENSE

Large diffs are not rendered by default.

86 changes: 86 additions & 0 deletions packages/mobile-top-nav/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
# \<scrubber-bar>

A customizable scrubber bar useful for scrubbing through media.


## Installation
```bash
yarn add @internetarchive/mobile-top-nav
```

## Usage
```js
// ia-mobile-top-nav.js
import IAMobileTopNav from '@internetarchive/mobile-top-nav';
export default IAMobileTopNav;
```

```html
<!-- index.html -->
<script type="module">
import './ia-mobile-top-nav.js';
</script>

<style>
scrubber-bar {
--thumbColor: white;
--thumbBorder: 1px solid black;
--trackFillColor: blue;
--trackColor: purple;
--trackBorder: 1px solid black;
--trackBorderRadius: 5px;
--trackHeight: 10px;
--thumbDiameter: 20px;
--scrubberBarHeight: 20px;
--thumbBorderRadius: 10px;
--webkitThumbTopMargin: -6px;
}
</style>

<scrubber-bar id="scrubberbar"></scrubber-bar>

<script>
const scrubberBar = document.getElementById('scrubberbar');

// listen for value changes
scrubberBar.addEventListener('valuechange', e => {
console.log('Value has changed, new value:', e.detail.value);
});

// set a different value
scrubberBar.value = 23;
</script>

```

# Development

## Prerequisite
```bash
yarn install
```

## Start Development Server
```bash
yarn start // start development server and typescript compiler
```

## Testing
```bash
yarn test
```

## Testing via browserstack
```bash
yarn test:bs
```

## Demoing using storybook
```bash
yarn storybook
```

## Linting
```bash
yarn lint
```
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html>
<head>
<meta charset="utf-8">
<script type="module" src="topnav-element.js"></script>
<script type="module" src="/src/topnav-element.js"></script>
<title>topnav-element</title>
<style>
body {
Expand Down
3 changes: 3 additions & 0 deletions packages/mobile-top-nav/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
import IAMobileTopNav from './src/topnav-element';

export default IAMobileTopNav;
16 changes: 16 additions & 0 deletions packages/mobile-top-nav/karma.bs.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
/* eslint-disable import/no-extraneous-dependencies */
const merge = require('webpack-merge');
const bsSettings = require('@open-wc/testing-karma-bs/bs-settings.js');
const createBaseConfig = require('./karma.conf.js');

module.exports = config => {
config.set(
merge(bsSettings(config), createBaseConfig(config), {
browserStack: {
project: 'mobile-top-nav',
},
}),
);

return config;
};
24 changes: 24 additions & 0 deletions packages/mobile-top-nav/karma.conf.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
/* eslint-disable import/no-extraneous-dependencies */
const { createDefaultConfig } = require('@open-wc/testing-karma');
const merge = require('webpack-merge');

module.exports = config => {
config.set(
merge(createDefaultConfig(config), {
files: [
// runs all files ending with .test in the test folder,
// can be overwritten by passing a --grep flag. examples:
//
// npm run test -- --grep test/foo/bar.test.js
// npm run test -- --grep test/bar/*
{ pattern: config.grep ? config.grep : 'test/**/*.test.js', type: 'module' },
],

esm: {
nodeResolve: true,
},
// you can overwrite/extend the config further
}),
);
return config;
};
70 changes: 70 additions & 0 deletions packages/mobile-top-nav/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
{
"name": "@internetarchive/mobile-top-nav",
"version": "0.0.0",
"description": "Top Nav for Internet Archive that is optimized for the mobile experience",
"license": "AGPL-3.0-only",
"main": "index.js",
"module": "index.js",
"scripts": {
"start": "owc-dev-server --open ./demo/index.html",
"lint:eslint": "eslint --ext .js,.html . --ignore-path .gitignore",
"format:eslint": "eslint --ext .js,.html . --fix --ignore-path .gitignore",
"lint:prettier": "prettier \"**/*.js\" --check --ignore-path .gitignore",
"format:prettier": "prettier \"**/*.js\" --write --ignore-path .gitignore",
"lint": "npm run lint:eslint && npm run lint:prettier",
"format": "npm run format:eslint && npm run format:prettier",
"test": "npm run build && karma start --coverage",
"test:watch": "karma start --auto-watch=true --single-run=false",
"test:update-snapshots": "karma start --update-snapshots",
"test:prune-snapshots": "karma start --prune-snapshots",
"test:compatibility": "karma start --compatibility all --coverage",
"test:compatibility:watch": "karma start --compatibility all --auto-watch=true --single-run=false",
"test:bs": "karma start karma.bs.config.js --compatibility all --coverage",
"site:build": "npm run storybook:build",
"storybook": "start-storybook -p 9001",
"storybook:build": "build-storybook -o _site -s storybook-static"
},
"dependencies": {
"lit-element": "^2.2.1",
"lit-html": "^1.0.0"
},
"devDependencies": {
"@open-wc/demoing-storybook": "^0.3.0",
"@open-wc/eslint-config": "^1.0.0",
"@open-wc/polyfills-loader": "^0.2.1",
"@open-wc/prettier-config": "^0.1.10",
"@open-wc/testing": "^2.0.0",
"@open-wc/testing-karma": "^3.0.0",
"@open-wc/testing-karma-bs": "^1.0.0",
"owc-dev-server": "^0.1.2",
"@storybook/react": "^5.1.11",
"concurrently": "^4.1.2",
"es-dev-server": "^1.5.0",
"eslint": "^6.1.0",
"eslint-plugin-lit": "^0.5.0",
"gulp": "^4.0.2",
"husky": "^1.0.0",
"lint-staged": "^8.0.0",
"polymer-cli": "^1.9.11",
"webpack-merge": "^4.1.5"
},
"eslintConfig": {
"extends": [
"@open-wc/eslint-config",
"eslint-config-prettier"
]
},
"prettier": "@open-wc/prettier-config",
"husky": {
"hooks": {
"pre-commit": "lint-staged"
}
},
"lint-staged": {
"*.js": [
"eslint --fix",
"prettier --write",
"git add"
]
}
}
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import { LitElement, html } from 'lit-element';

class HamBurger extends LitElement {

static get properties() {
return {
colour: { type: String }
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import { LitElement, html } from 'lit-element';

class Search extends LitElement {

static get properties() {
return {
colour: { type: String }
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import { LitElement, html } from 'lit-element';

class User extends LitElement {

static get properties() {
return {
colour: { type: String }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ import './media-slider';
import './assets/img/media-menu-images';

class MediaMenu extends LitElement {

static get properties() {
return {
mediaMenuOpen: { type: Boolean },
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import { LitElement, html, css } from 'lit-element';

class MediaSlider extends LitElement {

static get properties() {
return {
mediaSliderOpen: { type: Boolean },
Expand Down
Loading