1.0.41 • Published 2 years ago
@preamp-release-test/core v1.0.41
PreAmp Core
PreAmp Core in VideoAmp's component library.
File structure
core/
components/
componentGroup/ #holds all related components
singleComponent/ #single component
examples/ #example use cases
subComponents/ #child components used only by this component
component.md #documentation
component.tsx #component definition
component.spec.tsx #tests
Adding components
- Component definition
- include the description in a comment above the component definition
- component should be a named export, not default
- Props
- named with this format
[ComponentName]Props
- include the descriptions in a comment above each prop
- named with this format
- Examples
- include enough examples to show off all use cases for this component
- Tests
- TBD
- SubComponents
- subComponents used only this component should live in
/subComponents
. If a child component is used in multiple places, then it should be pulled out as a stand alone component
- subComponents used only this component should live in
- Types
- include only prop interfaces in component definition file
- put all other types in
core/types/
for reuse
Example Component.tsx file
import * as React from 'react';
interface ComponentProps {
/** Description of first prop */
propOne: string;
/** Description of the second prop */
propTwo: boolean
}
/**
* This is a description of Component.
*/
export const Component: React.SFC<ComponentProps> = (
props: ComponentProps
): React.ReactElement<any> => {
...
};
Note: React must be imported with * as
. Otherwise this file will not be parsed correctly for documentation generation.
How to publish
TODO
Using in another project
import multiple components at once from @preamp/core
import { Button, Card, TextField } from '@preamp/core';
1.0.41
2 years ago
1.0.37
2 years ago
1.0.36
2 years ago
1.0.35
2 years ago
1.0.34
2 years ago
1.0.33
2 years ago
1.0.32
2 years ago
1.0.31
2 years ago
1.0.30
2 years ago
1.0.29
2 years ago
1.0.28
2 years ago
1.0.27
2 years ago
1.0.26
2 years ago
1.0.25
2 years ago
1.0.24
2 years ago
1.0.23
2 years ago
1.0.22
2 years ago
1.0.21
2 years ago
1.0.20
2 years ago
1.0.19
2 years ago
1.0.18
2 years ago
1.0.17
2 years ago
1.0.16
2 years ago
1.0.15
2 years ago
1.0.14
2 years ago
1.0.13
2 years ago
1.0.12
2 years ago
1.0.11
2 years ago
1.0.10
2 years ago
1.0.9
2 years ago
1.0.8
2 years ago
1.0.7
2 years ago
1.0.6
2 years ago
1.0.5
2 years ago
1.0.4
2 years ago
1.0.3
2 years ago
1.0.2
2 years ago
1.0.1
2 years ago
1.0.0
2 years ago