Component Specification Proof of Concept

[mattrosno]

The purpose of this epic is to track a proof of concept to figure out:

1. How can we come up with a common way to write requirements so our users can understand why choices were made about a component and our framework developers can understand what outcomes are expected?
2. How can we write tests to confirm all frameworks are in sync?
3. How can components share a common API and what's included?

Outcomes

1. Acceptance criteria (what's expected from component specifications with working examples)
2. Technical Steering Committee consensus (as a blocking means to implement the backlog)
3. Documented backlog (component priority, future efforts outside of proof of concept scope, etc.)

In Scope

1. Components:
   • Button (static component with many variants / modifiers)
   • Checkbox (repeatable pattern)
   • Icon (dependency on Carbon Elements, but still a component)
   • Modal (JavaScript and user interaction)
2. Specifications that may include:
   • Component requirements
   • Component tests
   • Component demo configs to use in tests (and in documentation?)
   • Component selectors object or some other means to map demo content to where that content is placed in templates?
3. Tooling to run spec verification tests

Out Scope

1. Shared reporting of each carbon-components-x's spec adherence
2. Component generate functions that inform carbon-components-x templating

[scottnath]

Component Tests

For requirements on the tests, they need to work in these four test-runners:

• Mocha
• Jest
• Jasmine
• Protractor

And the above should work within these different browser-runners:

• Karma
• Selenium