Skip to content
Collection of Marko widgets; considered to be the core building blocks for all eBay components, pages & apps
HTML JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Created github issue templates (#195) May 23, 2018
.storybook Migrated skin-ds6 flag to ds-4 (#1024) Jan 16, 2020
demo Changed skin/global to skin/core Jan 31, 2020
docs 5.0.1 Feb 11, 2020
integration Migrated skin-ds6 flag to ds-4 (#1024) Jan 16, 2020
scripts Migrated skin-ds6 flag to ds-4 (#1024) Jan 16, 2020
src Fix typo in checkbox readme Feb 12, 2020
.babelrc
.browser-refresh-ignore
.eslintignore Integrate storybook for examples (#874) Sep 20, 2019
.eslintrc DevDeps: update to eslint 6.4.0 Sep 20, 2019
.gitignore Removed browser.json from integration tests Nov 18, 2019
.npmrc Adding .npmrc and publishConfig (#32) Mar 8, 2018
.nycrc Icon: exclude generated symbols from coverage (#366) Aug 22, 2018
.stylelintrc Initial commit Mar 1, 2018
.travis.yml Updated node to 10 for travis Feb 6, 2020
.yarnrc Initial commit Mar 1, 2018
CHANGELOG.md Add changelog file Feb 11, 2020
CONTRIBUTING.md Ported documentation about deprecation (#352) upstream to 5.0.0 (#980) Dec 10, 2019
LICENSE.txt Initial commit Mar 1, 2018
README.md Migrated skin-ds6 flag to ds-4 (#1024) Jan 16, 2020
karma.conf.js Initial commit Mar 1, 2018
marketplace.json Migrated skin-ds6 flag to ds-4 (#1024) Jan 16, 2020
marko-cli.js Removed windows firefox from CI (#1056) Feb 11, 2020
marko.json Merge branch 'master' into 5.0.0 Feb 6, 2020
package.json 5.0.1 Feb 11, 2020
yarn.lock Downgraded storybook and eslint compat Feb 7, 2020

README.md

Build Status Coverage Status Dependency status devDependency status

eBayUI Core

Collection of Marko widgets; considered to be the core building blocks for all eBay components, pages & apps.

Requirements

Note:
Marko v3 requires Marko Widgets v6
Marko v4 requires Marko Widgets v7

Note: eBayUI Core components utilize Marko flags and, therefore, require <lasso-page/> to be added to any page which will have core components.

Note: In order for spread attributes to work properly, marko@3.14.5 or marko@4.18.22 at least is required

Browser Policy

All components are developed and tested cross-browser using BrowserStack, in accordance with our official eBay Browser Policy.

Accessibility (A11Y)

We take accessibility very seriously. Very seriously indeed. Therefore, all components are built in accordance to the eBay MIND Patterns. These patterns, in turn, build on from the specifications provided by the WAI-ARIA Authoring Practices.

Components are built in a layered, progressively enhanced fashion, utilizing the following resources:

Each layer does its bit to enforce and enhance accessibility. We consider this level of support to be one of our chief selling points, and we hope you do too!

Components

Getting Started

The eBayUI core components are available as the @ebay/ebayui-core package on NPM.

Use npm or yarn to add the package dependency to your project:

yarn add @ebay/ebayui-core

Custom Tags

Once the package dependency is added, the eBay customs tags are now available for use in your Marko templates. For example, to use an ebay-menu component:

template.marko

<ebay-menu text="Sort" type="radio">
    <ebay-menu-item>Price</ebay-menu-item>
    <ebay-menu-item>Time</ebay-menu-item>
    <ebay-menu-item>Distance</ebay-menu-item>
</ebay-menu>

On Marko v3, remember to include the component's resources in your browser.json file.

browser.json

{
    "dependencies": [
        "@ebay/ebayui-core/ebay-menu"
    ]
}

Attributes

Attributes provide initial state for a component. We can see that the menu has text and type attributes:

template.marko

<ebay-menu text="Sort" type="radio">
    <ebay-menu-item>Price</ebay-menu-item>
    <ebay-menu-item>Time</ebay-menu-item>
    <ebay-menu-item>Distance</ebay-menu-item>
</ebay-menu>

Passing new attributes to an ebayui component will always reset it's internal state. If you want to persist this state yourself, events are exposed which allow you to synchronize the state into your own components, for example:

class {
    onCreate() {
        this.state = {
            dialogIsOpen: false
        }
    }

    handleDialogClose() {
        this.state.dialogIsOpen = false;
    }

    handleDialogOpen() {
        this.state.dialogIsOpen = true;
    }
}

<ebay-dialog
    open=state.dialogIsOpen
    on-dialog-open('handleDialogOpen')
    on-dialog-close('handleDialogClose')>
    ...
</ebay-dialog>

Pass-Through Attributes

HTML attributes can be used on any component, and they will be passed through to the most prominent tag of the component. The most prominent tag is usually the root or form control, but individual components will note if it varies for specific cases.

Example of static usage:

<ebay-button id="my-button"/>

For using pass-through attributes dynamically, they should be sent through the html-attributes attribute:

$ const myAttributes = { id: 'my-button' };
<ebay-button html-attributes=myAttributes/>

Static and dynamic pass-through attributes can be used simultaneously (html-attributes takes precedence in conflicts):

$ const myAttributes = { id: 'my-button' };
<ebay-button html-attributes=myAttributes type="submit"/>

Events

Events can also be handled using Marko syntax (or the legacy syntax for Marko v3):

template.marko

<ebay-menu text="Sort" type="radio" on-change("onMenuChange")>
    <ebay-menu-item>Price</ebay-menu-item>
    <ebay-menu-item>Time</ebay-menu-item>
    <ebay-menu-item>Distance</ebay-menu-item>
</ebay-menu>

Releases & Milestones

For upcoming roadmap and release history, please refer to our releases and milestones pages.

Versioning

The ebayui-core package follows strict Semantic Versioning.

Given a version number MAJOR.MINOR.PATCH:

  • MAJOR version is incremented when we make incompatible API changes
  • MINOR version is incremented when we add functionality in a backwards-compatible manner
  • PATCH version is incremented when we make backwards-compatible bug fixes.

Deprecations

Deprecations will be communicated via release notes, so please ensure that you read those carefully. In general, expect any deprecated feature to be removed in the next major version. However, in some cases we may wait a while longer.

Issues

Please use our issues page to ask questions, report issues or submit feature requests.

To help track your issue, our admins will assign it with one or more coloured labels:

  • Black: Issue Type (e.g. bug, question, test case)
  • White: Resolution (e.g. wont fix, invalid, duplicate)
  • Gray: Status (e.g. backlog, in progress, help wanted)
  • Red: Blocker (e.g. dependency, discussion, design)
  • Green: Module (e.g. button, radio, dialog)
  • Blue: Aspect (e.g. build, documentation, website)
  • Yellow: Semver Guidance (e.g. breaking change, backwards compatible)
  • Purple: Sprint (e.g. sprint 1, sprint 2, etc)

Contributing

Looking to contribute to eBay UI? Please visit our contributing page for more information.

License

Copyright (c) 2018 eBay Inc.

Use of this source code is governed by a MIT-style license that can be found in the LICENSE file or at https://opensource.org/licenses/MIT.

You can’t perform that action at this time.