Skip to content

Commit 2dfd553

Browse files
committed
Display all variations of format
It's useful to be able to see all the possible values of format, for reference, rather than just a few examples.
1 parent c279757 commit 2dfd553

File tree

1 file changed

+17
-8
lines changed

1 file changed

+17
-8
lines changed

dotcom-rendering/src/devServer/docs/article.tsx

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
import {
2+
ArticleDesign,
3+
ArticleDisplay,
4+
ArticleSpecial,
5+
Pillar,
6+
} from '../../lib/articleFormat';
17
import { Available } from './available';
28
import { descriptionLinks } from './styles';
39

@@ -89,6 +95,11 @@ const Examples = () => (
8995
</>
9096
);
9197

98+
const formatValues = (a: object): string =>
99+
Object.values(a)
100+
.filter((v) => typeof v !== 'number')
101+
.join(', ');
102+
92103
const Format = () => (
93104
<>
94105
<h2>Format</h2>
@@ -103,23 +114,21 @@ const Format = () => (
103114
<dd>
104115
Primarily influences the content, structure and features of an
105116
article. It's the most important of the three, and is often used
106-
as a shorthand to describe the "kind" of article. Examples
107-
include <code>Liveblog</code>, <code>Feature</code> and{' '}
108-
<code>Gallery</code>.
117+
as a shorthand to describe the "kind" of article. The values
118+
are: {formatValues(ArticleDesign)}.
109119
</dd>
110120
<dt>Display</dt>
111121
<dd>
112-
Primarily influences the layout of an article. Examples include{' '}
113-
<code>Immersive</code>, <code>Showcase</code> and{' '}
114-
<code>NumberedList</code>.
122+
Primarily influences the layout of an article. The values are:{' '}
123+
{formatValues(ArticleDisplay)}.
115124
</dd>
116125
<dt>Theme</dt>
117126
<dd>
118127
Primarily influences the fonts and colours of an article. It can
119128
can be thought of as a superset of "pillar", i.e. all the
120129
pillars are considered themes, but there are some additional
121-
themes that are not pillars. Examples include <code>News</code>,{' '}
122-
<code>Sport</code> and <code>Labs</code>.
130+
themes that are not pillars. The values are:{' '}
131+
{formatValues(Pillar)}, {formatValues(ArticleSpecial)}.
123132
</dd>
124133
</dl>
125134
<p>

0 commit comments

Comments
 (0)