Skip to content

Commit cac750e

Browse files
committed
AER-4544 - list the exports instead of tabulating them
Review: an unpadded table needs a prettier-ignore to survive format:check, and having to explain a formatting workaround in markdown comments is a cost of its own. Prettier's table padding is hardcoded - there is no option for it, printWidth does not affect it, and the one plugin in that space aligns rather than unpads - so keeping a table meant keeping the escape hatch. A list drops it entirely: prettier leaves these lines alone by default, an added export is one entry, and nothing has to be ignored or explained. The descriptions are full sentences of varying length, so the grid was not buying much scanning value anyway.
1 parent 28e4495 commit cac750e

1 file changed

Lines changed: 20 additions & 16 deletions

File tree

README.md

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -103,22 +103,26 @@ npm run build # type-check + build dist/
103103

104104
Everything comes from [`src/index.ts`](./src/index.ts):
105105

106-
<!-- Cells are left unpadded on purpose: padded cells mean one long export reflows every row. -->
107-
<!-- prettier-ignore -->
108-
| Export | What it is |
109-
| --- | --- |
110-
| `MapView` | The OpenLayers map as a Vue component. Shares the map with child components. |
111-
| `useMap` / `provideMap` / `mapInjectionKey` | Get or share the map instance. |
112-
| `registerProjection` / `isProjectionRegistered` | Register any projection (proj4 def + extent) with OpenLayers, keyed by EPSG code. |
113-
| `RD` / `RD_EXTENT` / `RD_PROJ4_DEFINITION` / `registerRdProjection` / `isRdRegistered` | Dutch RD map projection (EPSG:28992), built on `registerProjection`. |
114-
| `useMapViewStore` | Shared map state (center, zoom). |
115-
| `LayerType` / `LayerProps` and its per-type variants | The layer model: what a layer is, before it becomes an OpenLayers layer. |
116-
| `CombinedLayers` | A set of layers of which only one is visible at a time, such as base layers. |
117-
| `createLayer` | Build the OpenLayers layer a descriptor asks for. |
118-
| `toStylesMap` / `findStyleKey` / `toLegendStyleValues` | Turn layer style values into OpenLayers styles, or pick the one a value falls in. |
119-
| `LayerItemTemplate` | A layer panel row: visibility toggle, opacity slider and legend. |
120-
| `LayerItemsLegend` | The legend on its own, for a panel you build yourself. |
121-
| `LegendDisplay` / `LegendItem` | What a legend renders. Text is resolved by you, so the library carries no i18n. |
106+
- **`MapView`** - The OpenLayers map as a Vue component. Shares the map with child
107+
components.
108+
- **`useMap` / `provideMap` / `mapInjectionKey`** - Get or share the map instance.
109+
- **`registerProjection` / `isProjectionRegistered`** - Register any projection
110+
(proj4 def + extent) with OpenLayers, keyed by EPSG code.
111+
- **`RD` / `RD_EXTENT` / `RD_PROJ4_DEFINITION` / `registerRdProjection` / `isRdRegistered`** -
112+
Dutch RD map projection (EPSG:28992), built on `registerProjection`.
113+
- **`useMapViewStore`** - Shared map state (center, zoom).
114+
- **`LayerType` / `LayerProps` and its per-type variants** - The layer model: what a
115+
layer is, before it becomes an OpenLayers layer.
116+
- **`CombinedLayers`** - A set of layers of which only one is visible at a time, such as
117+
base layers.
118+
- **`createLayer`** - Build the OpenLayers layer a descriptor asks for.
119+
- **`toStylesMap` / `findStyleKey` / `toLegendStyleValues`** - Turn layer style values
120+
into OpenLayers styles, or pick the one a value falls in.
121+
- **`LayerItemTemplate`** - A layer panel row: visibility toggle, opacity slider and
122+
legend.
123+
- **`LayerItemsLegend`** - The legend on its own, for a panel you build yourself.
124+
- **`LegendDisplay` / `LegendItem`** - What a legend renders. Text is resolved by you, so
125+
the library carries no i18n.
122126

123127
## License
124128

0 commit comments

Comments
 (0)