8.14.5 • Published 10 months ago

@atlaskit/email-renderer v8.14.5

Weekly downloads
177
License
Apache-2.0
Repository
bitbucket
Last release
10 months ago

Email renderer

This package provides renderer that is capable of rendering email-friendly HTML from ADF documents.

Usage

Use as follows:

import { defaultSchema } from '@atlaskit/adf-schema';
import { EmailSerializer } from '@atlaskit/email-renderer';

const document = ... // Your ADF JSON document

const serializer = EmailSerializer.fromSchema(defaultSchema);
const node = defaultSchema.nodeFromJSON(document);
const result = serializer.serializeFragment(node.content);

Development

Project consists of different serializers in order to render ADF into html

ADF nodes serializers are stored in src/nodes ADF marks serializers are stored in src/marks

HTML rendering occurs via traversal of the ADF and calling the serializer corresponding to each visited ADF Node, as well as applying any marks that exist on a node.

Adding new embedded images / icons

This will generate static image modules that can be used to easily embed inside of email as part of a ADF node serializer, etc.

Currently uses a custom build process, which like this: SVG -> PNG -> Base64 -> TypeScript Module

  • Add the source image to src/static/svg folder and to generator config src/static/image-sources.ts
  • run yarn run build:images
8.14.5

10 months ago

8.14.4

10 months ago

8.14.3

10 months ago

8.14.2

10 months ago

8.14.1

10 months ago

8.14.0

10 months ago

8.13.3

12 months ago

8.13.2

12 months ago

8.11.0

1 year ago

8.12.0

1 year ago

8.13.1

1 year ago

8.13.0

1 year ago

8.8.1

1 year ago

8.8.3

1 year ago

8.8.2

1 year ago

8.10.0

1 year ago

8.10.1

1 year ago

8.9.0

1 year ago

8.8.0

1 year ago

8.7.1

1 year ago

8.7.0

1 year ago

8.6.4

1 year ago

8.6.3

1 year ago

8.6.2

1 year ago

8.6.1

1 year ago

8.6.0

1 year ago

8.5.20

1 year ago

8.5.19

1 year ago

8.5.18

1 year ago

8.5.17

1 year ago

8.5.16

1 year ago

8.5.15

1 year ago

8.5.14

1 year ago

8.5.13

1 year ago

8.5.12

2 years ago

8.5.11

2 years ago

8.5.10

2 years ago

8.5.9

2 years ago

8.5.8

2 years ago

8.5.7

2 years ago

8.5.6

2 years ago

8.5.5

2 years ago

8.5.4

2 years ago

8.5.3

2 years ago

8.5.2

2 years ago

8.5.1

2 years ago

8.2.3

2 years ago

8.4.0

2 years ago

8.2.2

2 years ago

8.2.5

2 years ago

8.2.4

2 years ago

8.3.0

2 years ago

8.5.0

2 years ago

8.3.2

2 years ago

8.1.4

2 years ago

8.3.1

2 years ago

8.3.3

2 years ago

8.1.5

2 years ago

8.2.1

2 years ago

8.2.0

2 years ago

8.1.0

2 years ago

8.1.2

2 years ago

8.1.1

2 years ago

8.0.12

2 years ago

8.0.13

2 years ago

8.1.3

2 years ago

8.0.10

3 years ago

8.0.11

3 years ago

8.0.9

3 years ago

8.0.8

3 years ago

8.0.7

3 years ago

8.0.6

3 years ago

8.0.5

3 years ago

8.0.4

3 years ago

8.0.1

4 years ago

8.0.3

4 years ago

8.0.2

4 years ago

8.0.0

4 years ago

7.0.0

4 years ago

6.3.0

4 years ago

6.2.5

4 years ago

6.2.4

4 years ago

6.2.3

4 years ago

6.2.2

4 years ago

6.2.1

4 years ago

6.2.0

4 years ago

6.1.9

4 years ago

6.1.6

4 years ago

6.1.8

4 years ago

6.1.7

4 years ago

6.1.5

4 years ago

6.1.4

5 years ago

6.1.3

5 years ago

6.1.2

5 years ago

6.1.1

5 years ago

6.1.0

5 years ago

6.0.2

5 years ago

6.0.1

5 years ago

6.0.0

5 years ago

5.0.2

5 years ago

5.0.1

5 years ago

5.0.0

5 years ago

4.2.1

5 years ago

4.2.0

5 years ago

4.1.1

5 years ago

4.1.0

5 years ago

4.0.3

6 years ago

4.0.2

6 years ago

4.0.1

6 years ago

4.0.0

6 years ago

3.0.2

6 years ago

3.0.1

6 years ago

3.0.0

6 years ago

2.10.3

6 years ago

2.10.2

6 years ago

2.10.1

6 years ago

2.10.0

6 years ago

2.9.0

6 years ago

2.8.0

6 years ago

2.7.1

6 years ago

2.7.0

6 years ago

2.6.0

6 years ago

2.5.0

6 years ago

2.4.0

6 years ago

2.3.0

6 years ago

2.2.0

6 years ago

2.1.0

6 years ago

2.0.0

6 years ago

1.4.0

6 years ago

1.3.0

6 years ago

1.2.0

6 years ago

1.1.1

6 years ago

1.1.0

6 years ago

1.0.0

6 years ago