@orbit-ui/experimental
Full documentation available at: https://orbit.sharegate.design
What differentiate an “experimental” component from a “stable” component?
Contrary to a “stable” component, an “experimental” component may:
- Not have a final stamp of approval from the design team.
- Not have all its variants or usecases defined.
- Not have a complete test coverage.
- Not have a final documentation.
By having fewer requirements in regards to the design team approbation, testing coverage and documentation we believe an “experimental” component could go out about 60% to 65% faster than a “stable” component.
What should an “experimental” component support from day 1?
An “experimental” component must:
- Leverage Orbit’s shared utilities
- Use Orbit’s tokens, color schemes and theming
- Implement Orbit’s style props
- Support Orbit’s responsive styles
- Support Orbit’s as function
- Follow Orbit’s components software design requirements
- Match Orbit’s developers experience expectations
- Follow Orbit’s naming conventions
Rules
As we do not want the package to me be misused nor cause harm to Orbit’s “stable” components we define rules which will guide our actions.
Those rules will have to be included in the “experimental” package documentation on Github.
- Changes to “stable” code should always be done in a distinct PR.
- Every “experimental” components should implement basic requirements.
- “Experimental” components shouldn’t be specific to an application.
- “Experimental” components must be released in a different package than the “stable” components.
- “Experimental” components code is isolated from “stable” code.
- “Experimental” components shouldn’t require new third party dependencies. If a component has a very good reason to install a new third party, it should be approved by the Collège de gouvernance FE first.
- An “experimental” component doesn’t have to be accessible from the beginning but is expected to have a realistic path toward accessibility (the component will have to be WAI ARIA AA requirements before being promoted to a “stable” component). We encourage developers to build accessible components from the ground up when possible.
Adding a new “experimental” component
Refer to the "Adding a new component" section in the components' package README
Flagging an “experimental” component in the documentation
Make sure to add the following component in the Usage Section
<ExperimentalMessage />Some props are available to detail the component's status.
<ExperimentalMessage noDoc noTests noVisualTesting noFinalDesign noMobileSupport />License
Copyright © 2023, GSoft inc. This code is licensed under the Apache License, Version 2.0. You may obtain a copy of this license at https://github.com/gsoft-inc/gsoft-license/blob/master/LICENSE.