@@ -10,37 +10,78 @@ within the library itself.
1010You can view the latest version of each component in the
1111[ storybook] ( https://dev.macrostrat.org/docs/web-components/?path=/docs/text-extractions-text-extraction--docs )
1212
13- ## Architecture
13+ ## Usage
1414
15- #### Libraries
15+ ### Libraries
1616
1717Macrostrat's web components system is a workbench for producing user interface
1818components. It is structured as a monorepo, with several modules (in the
1919` packages ` directory) that are being maintained for publication to NPM and
2020referencing in Macrostrat's user-facing applications. Open-source contributions
2121and third-party usage are welcome!
2222
23- Following is a list of all published modules
24-
25- [ ![ @macrostrat/api-types ] ( https://img.shields.io/npm/v/@macrostrat/api-types?label=%40macrostrat%2Fapi-types )] ( https://www.npmjs.com/package/@macrostrat/api-types )
26- [ ![ @macrostrat/color-utils ] ( https://img.shields.io/npm/v/@macrostrat/color-utils?label=%40macrostrat%2Fcolor-utils )] ( https://www.npmjs.com/package/@macrostrat/color-utils )
27- [ ![ @macrostrat/column-components ] ( https://img.shields.io/npm/v/@macrostrat/column-components?label=%40macrostrat%2Fcolumn-components )] ( https://www.npmjs.com/package/@macrostrat/column-components )
28- [ ![ @macrostrat/column-views ] ( https://img.shields.io/npm/v/@macrostrat/column-views?label=%40macrostrat%2Fcolumn-views )] ( https://www.npmjs.com/package/@macrostrat/column-views )
29- [ ![ @macrostrat/data-components ] ( https://img.shields.io/npm/v/@macrostrat/data-components?label=%40macrostrat%2Fdata-components )] ( https://www.npmjs.com/package/@macrostrat/data-components )
30- [ ![ @macrostrat/data-sheet ] ( https://img.shields.io/npm/v/@macrostrat/data-sheet?label=%40macrostrat%2Fdata-sheet )] ( https://www.npmjs.com/package/@macrostrat/data-sheet )
31- [ ![ @macrostrat/feedback-components ] ( https://img.shields.io/npm/v/@macrostrat/feedback-components?label=%40macrostrat%2Ffeedback-components )] ( https://www.npmjs.com/package/@macrostrat/feedback-components )
32- [ ![ @macrostrat/form-components ] ( https://img.shields.io/npm/v/@macrostrat/form-components?label=%40macrostrat%2Fform-components )] ( https://www.npmjs.com/package/@macrostrat/form-components )
33- [ ![ @macrostrat/map-interface ] ( https://img.shields.io/npm/v/@macrostrat/map-interface?label=%40macrostrat%2Fmap-interface )] ( https://www.npmjs.com/package/@macrostrat/map-interface )
34- [ ![ @macrostrat/map-styles ] ( https://img.shields.io/npm/v/@macrostrat/map-styles?label=%40macrostrat%2Fmap-styles )] ( https://www.npmjs.com/package/@macrostrat/map-styles )
35- [ ![ @macrostrat/mapbox-react ] ( https://img.shields.io/npm/v/@macrostrat/mapbox-react?label=%40macrostrat%2Fmapbox-react )] ( https://www.npmjs.com/package/@macrostrat/mapbox-react )
36- [ ![ @macrostrat/mapbox-utils ] ( https://img.shields.io/npm/v/@macrostrat/mapbox-utils?label=%40macrostrat%2Fmapbox-utils )] ( https://www.npmjs.com/package/@macrostrat/mapbox-utils )
37- [ ![ @macrostrat/stratigraphy-utils ] ( https://img.shields.io/npm/v/@macrostrat/stratigraphy-utils?label=%40macrostrat%2Fstratigraphy-utils )] ( https://www.npmjs.com/package/@macrostrat/stratigraphy-utils )
38- [ ![ @macrostrat/style-system ] ( https://img.shields.io/npm/v/@macrostrat/style-system?label=%40macrostrat%2Fstyle-system )] ( https://www.npmjs.com/package/@macrostrat/style-system )
39- [ ![ @macrostrat/svg-map-components ] ( https://img.shields.io/npm/v/@macrostrat/svg-map-components?label=%40macrostrat%2Fsvg-map-components )] ( https://www.npmjs.com/package/@macrostrat/svg-map-components )
40- [ ![ @macrostrat/timescale ] ( https://img.shields.io/npm/v/@macrostrat/timescale?label=%40macrostrat%2Ftimescale )] ( https://www.npmjs.com/package/@macrostrat/timescale )
41- [ ![ @macrostrat/ui-components ] ( https://img.shields.io/npm/v/@macrostrat/ui-components?label=%40macrostrat%2Fui-components )] ( https://www.npmjs.com/package/@macrostrat/ui-components )
42-
43- ## Contributing to web components
23+ - [ ![ @macrostrat/api-types ] ( https://img.shields.io/npm/v/@macrostrat/api-types?label=%40macrostrat%2Fapi-types )] ( https://www.npmjs.com/package/@macrostrat/api-types )
24+ - [ ![ @macrostrat/color-utils ] ( https://img.shields.io/npm/v/@macrostrat/color-utils?label=%40macrostrat%2Fcolor-utils )] ( https://www.npmjs.com/package/@macrostrat/color-utils )
25+ - [ ![ @macrostrat/column-components ] ( https://img.shields.io/npm/v/@macrostrat/column-components?label=%40macrostrat%2Fcolumn-components )] ( https://www.npmjs.com/package/@macrostrat/column-components )
26+ - [ ![ @macrostrat/column-views ] ( https://img.shields.io/npm/v/@macrostrat/column-views?label=%40macrostrat%2Fcolumn-views )] ( https://www.npmjs.com/package/@macrostrat/column-views )
27+ - [ ![ @macrostrat/data-components ] ( https://img.shields.io/npm/v/@macrostrat/data-components?label=%40macrostrat%2Fdata-components )] ( https://www.npmjs.com/package/@macrostrat/data-components )
28+ - [ ![ @macrostrat/data-sheet ] ( https://img.shields.io/npm/v/@macrostrat/data-sheet?label=%40macrostrat%2Fdata-sheet )] ( https://www.npmjs.com/package/@macrostrat/data-sheet )
29+ - [ ![ @macrostrat/feedback-components ] ( https://img.shields.io/npm/v/@macrostrat/feedback-components?label=%40macrostrat%2Ffeedback-components )] ( https://www.npmjs.com/package/@macrostrat/feedback-components )
30+ - [ ![ @macrostrat/form-components ] ( https://img.shields.io/npm/v/@macrostrat/form-components?label=%40macrostrat%2Fform-components )] ( https://www.npmjs.com/package/@macrostrat/form-components )
31+ - [ ![ @macrostrat/map-interface ] ( https://img.shields.io/npm/v/@macrostrat/map-interface?label=%40macrostrat%2Fmap-interface )] ( https://www.npmjs.com/package/@macrostrat/map-interface )
32+ - [ ![ @macrostrat/map-styles ] ( https://img.shields.io/npm/v/@macrostrat/map-styles?label=%40macrostrat%2Fmap-styles )] ( https://www.npmjs.com/package/@macrostrat/map-styles )
33+ - [ ![ @macrostrat/mapbox-react ] ( https://img.shields.io/npm/v/@macrostrat/mapbox-react?label=%40macrostrat%2Fmapbox-react )] ( https://www.npmjs.com/package/@macrostrat/mapbox-react )
34+ - [ ![ @macrostrat/mapbox-utils ] ( https://img.shields.io/npm/v/@macrostrat/mapbox-utils?label=%40macrostrat%2Fmapbox-utils )] ( https://www.npmjs.com/package/@macrostrat/mapbox-utils )
35+ - [ ![ @macrostrat/static-map-utils ] ( https://img.shields.io/npm/v/@macrostrat/static-map-utils?label=%40macrostrat%2Fstatic-map-utils )] ( https://www.npmjs.com/package/@macrostrat/static-map-utils )
36+ - [ ![ @macrostrat/stratigraphy-utils ] ( https://img.shields.io/npm/v/@macrostrat/stratigraphy-utils?label=%40macrostrat%2Fstratigraphy-utils )] ( https://www.npmjs.com/package/@macrostrat/stratigraphy-utils )
37+ - [ ![ @macrostrat/style-system ] ( https://img.shields.io/npm/v/@macrostrat/style-system?label=%40macrostrat%2Fstyle-system )] ( https://www.npmjs.com/package/@macrostrat/style-system )
38+ - [ ![ @macrostrat/svg-map-components ] ( https://img.shields.io/npm/v/@macrostrat/svg-map-components?label=%40macrostrat%2Fsvg-map-components )] ( https://www.npmjs.com/package/@macrostrat/svg-map-components )
39+ - [ ![ @macrostrat/timescale ] ( https://img.shields.io/npm/v/@macrostrat/timescale?label=%40macrostrat%2Ftimescale )] ( https://www.npmjs.com/package/@macrostrat/timescale )
40+ - [ ![ @macrostrat/ui-components ] ( https://img.shields.io/npm/v/@macrostrat/ui-components?label=%40macrostrat%2Fui-components )] ( https://www.npmjs.com/package/@macrostrat/ui-components )
41+
42+ ### Style imports
43+
44+ Many packages in this monorepo have styles that need to be imported separately
45+ into consuming applications. These styles can be imported into HTML
46+
47+ ``` html
48+ <link
49+ rel =" stylesheet"
50+ href =" @macrostrat/column-components/dist/column-components.css"
51+ />
52+ ```
53+
54+ or into JavaScript/TypeScript files:
55+
56+ ``` ts
57+ import " @macrostrat/column-components/dist/column-components.css" ;
58+ ```
59+
60+ For each package, styles can also be imported using a synthetic default import:
61+
62+ ``` ts
63+ import " @macrostrat/column-components/style.css" ;
64+ ```
65+
66+ The following table lists the packages that require separate style imports,
67+ along with the version since which the style import has been necessary.
68+
69+ | Module | Stylesheet | Since |
70+ | ---------------------------------- | ---------------------------------- | ------- |
71+ | ` @macrostrat/column-components ` | ` .../dist/column-components.css ` | ` 2.0.0 ` |
72+ | ` @macrostrat/column-creator ` | ` .../dist/column-creator.css ` | ` 0.2.0 ` |
73+ | ` @macrostrat/column-views ` | ` .../dist/column-views.css ` | ` 3.0.0 ` |
74+ | ` @macrostrat/data-components ` | ` .../dist/data-components.css ` | ` 1.0.0 ` |
75+ | ` @macrostrat/data-sheet ` | ` .../dist/data-sheet.css ` | ` 3.0.0 ` |
76+ | ` @macrostrat/feedback-components ` | ` .../dist/feedback-components.css ` | ` 2.0.0 ` |
77+ | ` @macrostrat/form-components ` | ` .../dist/form-components.css ` | ` 1.0.0 ` |
78+ | ` @macrostrat/map-interface ` | ` .../dist/map-interface.css ` | ` 2.0.0 ` |
79+ | ` @macrostrat/static-map-utils ` | ` .../dist/static-map-utils.css ` | ` 2.0.0 ` |
80+ | ` @macrostrat/timescale ` | ` .../dist/timescale.css ` | ` 3.0.0 ` |
81+ | ` @macrostrat/ui-components ` | ` .../dist/ui-components.css ` | ` 5.0.0 ` |
82+ | ---------------------------------- | ---------------------------------- | ------- |
83+
84+ ## Contributing
4485
4586### Installation
4687
0 commit comments