Skip to content
This repository was archived by the owner on Feb 6, 2024. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
4e0e4d8
math: added new components for math expression
boradakash Apr 26, 2020
29d764e
feat: update math component for editable
boradakash May 3, 2020
86fe1e8
math: style update
boradakash May 3, 2020
5ab87d7
studio: integrated math component in studio
boradakash May 3, 2020
9f24aa2
utils: added global style for deckgo-math
boradakash May 3, 2020
6bb0dcb
math: added props to support options from studio popover
boradakash May 4, 2020
8df5d3e
studio: added popover for math options
boradakash May 4, 2020
5d3ef99
math-cmp: few small changes
boradakash May 9, 2020
4ffa306
Merge pull request #718 from boradakash/math-exp
peterpeterparker May 10, 2020
5514eb9
feat(#622): update dependencies
peterpeterparker May 10, 2020
de321fe
docs(#622): add some content to README
peterpeterparker May 10, 2020
f30cb33
docs(#622): render math
peterpeterparker May 10, 2020
e93d458
feat(#622): no dev and more examples
peterpeterparker May 10, 2020
c33c1d8
feat(#622): add katex typescript definition
peterpeterparker May 10, 2020
06c133d
feat(#622): no sub div container
peterpeterparker May 10, 2020
ac579ee
fix(#622): childnodes can be just a text
peterpeterparker May 10, 2020
3624fe7
feat(#622): add property macros
peterpeterparker May 10, 2020
6037dcf
feat(#622): handle chars
peterpeterparker May 10, 2020
abc9001
merge: from master
peterpeterparker May 11, 2020
e080d26
feat: update libs
peterpeterparker May 11, 2020
de7e9fe
feat: don't emit error
peterpeterparker May 11, 2020
2a77cd5
fix: refresh after update only when necessary
peterpeterparker May 11, 2020
a61a766
feat: use ref
peterpeterparker May 11, 2020
46370d5
feat: we don't support chemical expression
peterpeterparker May 12, 2020
ff35168
feat: use p and spacing
peterpeterparker May 12, 2020
43df5e3
fix: support reset to empty on edit
peterpeterparker May 12, 2020
8251606
feat: inherit alignment
peterpeterparker May 12, 2020
b4208d5
feat: border in fullscreen for math
peterpeterparker May 13, 2020
5881884
feat: font size and element
peterpeterparker May 13, 2020
3388ffe
feat: keep component lean for a first version and studio options
peterpeterparker May 13, 2020
88e6533
feat: use code element as slot
peterpeterparker May 14, 2020
346af6b
feat: math icon
peterpeterparker May 14, 2020
0401d8d
feat: align math expression
peterpeterparker May 14, 2020
e4a730b
release: deck-utils v2.3.0
peterpeterparker May 14, 2020
4649d86
release: new component math
peterpeterparker May 14, 2020
900454d
feat: credits Akash Borad for creating the new math component
peterpeterparker May 14, 2020
ba31bbd
feat: use published libs math
peterpeterparker May 14, 2020
66f9016
feat: install new component math
peterpeterparker May 14, 2020
bb4f6a3
docs: new component math
peterpeterparker May 14, 2020
96fb3fd
docs: add starter and fix new version content
peterpeterparker May 14, 2020
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 35 additions & 7 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,21 @@
<a name="1.1.0"></a>
<a name="1.2.0"></a>

# [1.1.0](https://github.com/deckgo/deckdeckgo/compare/v1.0.0...v1.1.0) (2020-07-08)
# [1.2.0](https://github.com/deckgo/deckdeckgo/compare/v1.1.0...v1.2.0) (2020-07-14)

### Applications

- demo: v2.2.0 ([CHANGELOG](https://github.com/deckgo/deckdeckgo-website/blob/master/CHANGELOG.md))
- docs: v1.1.0 ([CHANGELOG](https://github.com/deckgo/deckdeckgo/blob/master/docs/CHANGELOG.md))
- remote: v1.1.0 ([CHANGELOG](https://github.com/deckgo/deckdeckgo/blob/master/remote/CHANGELOG.md))
- studio: v1.1.0 ([CHANGELOG](https://github.com/deckgo/deckdeckgo/blob/master/studio/CHANGELOG.md))
- docs: v1.2.0 ([CHANGELOG](https://github.com/deckgo/deckdeckgo/blob/master/docs/CHANGELOG.md))

### Web Components: New

- demo: v1.0.4 ([CHANGELOG](https://github.com/deckgo/deckdeckgo/blob/master/webcomponents/demo/CHANGELOG.md))
- math: v1.0.1 ([CHANGELOG](https://github.com/deckgo/deckdeckgo/blob/master/webcomponents/math/CHANGELOG.md))

### Web Components: Update

- charts: v1.0.2 ([CHANGELOG](https://github.com/deckgo/deckdeckgo/blob/master/webcomponents/charts/CHANGELOG.md))
- color: v1.1.1 ([CHANGELOG](https://github.com/deckgo/deckdeckgo/blob/master/webcomponents/color/CHANGELOG.md))
- core: v1.0.2 ([CHANGELOG](https://github.com/deckgo/deckdeckgo/blob/master/webcomponents/core/CHANGELOG.md))
- demo: v1.0.4 ([CHANGELOG](https://github.com/deckgo/deckdeckgo/blob/master/webcomponents/demo/CHANGELOG.md))
- drag-resize-rotate: v1.0.2 ([CHANGELOG](https://github.com/deckgo/deckdeckgo/blob/master/webcomponents/drag-resize-rotate/CHANGELOG.md))
- highlight-code: v1.0.5 ([CHANGELOG](https://github.com/deckgo/deckdeckgo/blob/master/webcomponents/highlight-code/CHANGELOG.md))
- inline-editor: v1.2.1 ([CHANGELOG](https://github.com/deckgo/deckdeckgo/blob/master/webcomponents/inline-editor/CHANGELOG.md))
Expand Down Expand Up @@ -46,6 +44,36 @@

### Others

- deck-utils: v2.3.0 ([CHANGELOG](https://github.com/deckgo/deckdeckgo/blob/master/utils/deck/CHANGELOG.md))
- starter kit: v2.3.0 ([CHANGELOG](https://github.com/deckgo/deckdeckgo-starter/blob/master/CHANGELOG.md))

<a name="1.1.0"></a>

# [1.1.0](https://github.com/deckgo/deckdeckgo/compare/v1.0.0...v1.1.0) (2020-07-08)

### Applications

- demo: v2.2.0 ([CHANGELOG](https://github.com/deckgo/deckdeckgo-website/blob/master/CHANGELOG.md))
- docs: v1.1.0 ([CHANGELOG](https://github.com/deckgo/deckdeckgo/blob/master/docs/CHANGELOG.md))
- remote: v1.1.0 ([CHANGELOG](https://github.com/deckgo/deckdeckgo/blob/master/remote/CHANGELOG.md))
- studio: v1.1.0 ([CHANGELOG](https://github.com/deckgo/deckdeckgo/blob/master/studio/CHANGELOG.md))

### Web Components: New

- demo: v1.0.3 ([CHANGELOG](https://github.com/deckgo/deckdeckgo/blob/master/webcomponents/demo/CHANGELOG.md))

### Web Components: Update

- highlight-code: v1.0.4 ([CHANGELOG](https://github.com/deckgo/deckdeckgo/blob/master/webcomponents/highlight-code/CHANGELOG.md))
- inline-editor: v1.2.0 ([CHANGELOG](https://github.com/deckgo/deckdeckgo/blob/master/webcomponents/inline-editor/CHANGELOG.md))
- youtube: v1.1.1 ([CHANGELOG](https://github.com/deckgo/deckdeckgo/blob/master/webcomponents/youtube/CHANGELOG.md))

### Web Components Templates

- slide-split: v1.1.2 ([CHANGELOG](https://github.com/deckgo/deckdeckgo/blob/master/webcomponents/slides/split/CHANGELOG.md))

### Others

- deck-utils: v2.2.0 ([CHANGELOG](https://github.com/deckgo/deckdeckgo/blob/master/utils/deck/CHANGELOG.md))
- slide-utils: v1.1.1 ([CHANGELOG](https://github.com/deckgo/deckdeckgo/blob/master/utils/slide/CHANGELOG.md))
- starter kit: v2.2.0 ([CHANGELOG](https://github.com/deckgo/deckdeckgo-starter/blob/master/CHANGELOG.md))
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ Are you interested to contribute to our open source project? That would be aweso
| **Highlight code** | [`@deckdeckgo/highlight-code`](https://www.npmjs.com/package/@deckdeckgo/highlight-code) | [![version](https://img.shields.io/npm/v/@deckdeckgo/highlight-code/latest.svg?color=success)](https://www.npmjs.com/package/@deckdeckgo/highlight-code) | [`README.md`](webcomponents/highlight-code/README.md) |
| **Inline editor** | [`@deckdeckgo/inline-editor`](https://www.npmjs.com/package/@deckdeckgo/inline-editor) | [![version](https://img.shields.io/npm/v/@deckdeckgo/inline-editor/latest.svg?color=success)](https://www.npmjs.com/package/@deckdeckgo/inline-editor) | [`README.md`](webcomponents/inline-editor/README.md) |
| **Lazy image** | [`@deckdeckgo/lazy-img`](https://www.npmjs.com/package/@deckdeckgo/lazy-img) | [![version](https://img.shields.io/npm/v/@deckdeckgo/lazy-img/latest.svg?color=success)](https://www.npmjs.com/package/@deckdeckgo/lazy-img) | [`README.md`](webcomponents/lazy-img/README.md) |
| **Math** | [`@deckdeckgo/math`](https://www.npmjs.com/package/@deckdeckgo/math) | [![version](https://img.shields.io/npm/v/@deckdeckgo/math/latest.svg?color=success)](https://www.npmjs.com/package/@deckdeckgo/math) | [`README.md`](webcomponents/math/README.md) |
| **QR-Code** | [`@deckdeckgo/qrcode`](https://www.npmjs.com/package/@deckdeckgo/qrcode) | [![version](https://img.shields.io/npm/v/@deckdeckgo/qrcode/latest.svg?color=success)](https://www.npmjs.com/package/@deckdeckgo/qrcode) | [`README.md`](webcomponents/qrcode/README.md) |
| **Remote** | [`@deckdeckgo/remote`](https://www.npmjs.com/package/@deckdeckgo/remote) | [![version](https://img.shields.io/npm/v/@deckdeckgo/remote/latest.svg?color=success)](https://www.npmjs.com/package/@deckdeckgo/remote) | [`README.md`](webcomponents/remote/README.md) |
| **Social** | [`@deckdeckgo/social`](https://www.npmjs.com/package/@deckdeckgo/social) | [![version](https://img.shields.io/npm/v/@deckdeckgo/social/latest.svg?color=success)](https://www.npmjs.com/package/@deckdeckgo/social) | [`README.md`](webcomponents/social/README.md) |
Expand Down
6 changes: 6 additions & 0 deletions docs/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
# 1.2.0 (2020-05-14)

### Features

- new component `math`

# 1.1.0 (2020-05-07)

### Features
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ It's recommended to use [unpkg](https://unpkg.com/) to use the [DeckDeckGo] lazy

### Install from NPM

Install it in your project from [npm](https://www.npmjs.com/package/@deckdeckgo/qrcode) using the following command:
Install it in your project from [npm](https://www.npmjs.com/package/@deckdeckgo/demo) using the following command:

```bash
npm install @deckdeckgo/demo
Expand Down
144 changes: 144 additions & 0 deletions docs/docs/components/app-components-math/app-components-math.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,144 @@
# Demo

Write and render math expressions.

This component is using [Katex](https://katex.org/) to renders these.

## Table of contents

- [Showcase](#app-components-math-showcase)
- [Installation](#app-components-math-installation)
- [Using from a CDN](#app-components-math-from-a-cdn)
- [Install from NPM](#app-components-math-from-npm)
- [Framework integration](#app-components-math-framework-integration)
- [Usage](#app-components-math-usage)
- [Slots](#app-components-math-slots)
- [Attributes](#app-components-math-attributes)
- [Events](#app-components-math-events)
- [Theming](#app-components-math-theming)

## Showcase

<div style={{position: 'relative'}}>
<deckgo-math>
<code slot="math">{`% \\f is defined as f(#1) using the macro
\\f{x} = \\int_{-\\infty}^\\infty
\\hat \\f\\xi\\,e^{2 \\pi i \\xi x}
\\,d\\xi`}</code>
</deckgo-math>
</div>

## Installation

This component could be added to your web application using the following methods.

### Using from a CDN

It's recommended to use [unpkg](https://unpkg.com/) to use the [DeckDeckGo] lazy image component from a CDN. To do so, add the following include script in the main HTML file of your project:

```
<script type="module" src="https://unpkg.com/@deckdeckgo/math@latest/dist/deckdeckgo-math/deckdeckgo-math.esm.js"></script>
<script nomodule="" src="https://unpkg.com/@deckdeckgo/math@latest/dist/deckdeckgo-math/deckdeckgo-math.js"></script>
```

### Install from NPM

Install it in your project from [npm](https://www.npmjs.com/package/@deckdeckgo/math) using the following command:

```bash
npm install @deckdeckgo/math
```

### Framework integration

The [Stencil documentation](https://stenciljs.com/docs/overview) provide examples of framework integration for [Angular](https://stenciljs.com/docs/angular), [React](https://stenciljs.com/docs/react), [Vue](https://stenciljs.com/docs/vue) and [Ember](https://stenciljs.com/docs/ember).

That being said, commonly, you might either `import` or `load` it:

#### Import

```
import '@deckdeckgo/math';
```

#### Loader

```
import { defineCustomElements as deckDeckGoElement } from '@deckdeckgo/math/dist/loader';
deckDeckGoElement();
```

## Usage

The "Math" Web Component could be integrated using the tag `<deckgo-math/>`.

```
<deckgo-math>
<code slot="math">% \f is defined as f(#1) using the macro
\f{x} = \int_{-\infty}^\infty
\hat \f\xi\,e^{2 \pi i \xi x}
\,d\xi</code>
</deckgo-math>
```

It either supports a single expression, as displayed above, or expressions within paragraphs.

```
<deckgo-math editable="true">
<code slot="math">
You can write math expression inside paragraph like this: $x + 1$

Inline formulas can be written with \$ e.g: $c = \pm\sqrt{a^2 + b^2}$

and displayed equations can be written using \$$ e.g: $$\sum_{i=1}^n 2^i$$
</code>
</deckgo-math>
```

### Slots

The expressions have to be provided using the slot `math`.

### Attributes

This component offers the following options which could be set using attributes:

| Attribute | Type | Default | Description |
| --------- | ------- | --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| macros | string | &#123;"\\\\f":"f(#1)"&#123; | A collection of custom macros. Each macro is a property with a name like \name (written "\\name" in JavaScript) which maps to a string that describes the expansion of the macro, or a function that accepts an instance of MacroExpander as first argument and returns the expansion as a string. |
| editable | boolean | `false` | To set the component has being editable (`contenteditable` will be applied on the `slot` on `click`) |

See the [Katex](https://katex.org/docs/options.html) documentation for more information.

### Events

The `<deckgo-math/>` component triggers the following event.

| Event | Description | Type |
| --------------- | ------------------------------------ | -------------------------- |
| `mathDidChange` | Emit the host element when modified. | `CustomEvent<HTMLElement>` |

### Theming

The following theming options will affect this component if set on its host or parent.

| CSS4 variable | Default | Note |
| --------------------------------------- | ----------------------------------- | ------------------------------------------------ |
| --deckgo-math-color | inherit | Color |
| --deckgo-math-background | | Background |
| --deckgo-math-padding | 8px | Padding |
| --deckgo-math-border-radius | | Border radius |
| --deckgo-math-margin | 0px | Margin |
| --deckgo-math-direction | | Direction |
| --deckgo-math-text-align | | Text alignment |
| --deckgo-math-container-display | block | Container display |
| --deckgo-math-container-justify-content | | Container justify-content attribute |
| --deckgo-math-container-flex-direction | | Container flex-direction attribute |
| --deckgo-math-container-align-items | | Container align-items attribute |
| --deckgo-math-scroll | scroll | Scroll property of the expression(s) |
| --deckgo-math-font-size | | Font size property of the expression(s) |
| --deckgo-math-min-height | 23px | Minimal height property of the expression(s) |
| --deckgo-math-display | block | Display property of the expression(s) |
| --deckgo-math-code-empty-text | "Click to add your math expression" | Place holder in case `editable` is set to `true` |

[deckdeckgo]: https://deckdeckgo.com
64 changes: 59 additions & 5 deletions docs/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion docs/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "deckdeckgo-docs",
"version": "1.1.0",
"version": "1.2.0",
"description": "The Progressive Web App alternative for simple presentations",
"license": "MIT",
"files": [
Expand All @@ -17,11 +17,13 @@
"@deckdeckgo/charts": "^1.0.1",
"@deckdeckgo/color": "^1.1.0",
"@deckdeckgo/core": "^1.0.1",
"@deckdeckgo/deck-utils": "^2.3.0",
"@deckdeckgo/demo": "^1.0.2",
"@deckdeckgo/drag-resize-rotate": "^1.0.0",
"@deckdeckgo/highlight-code": "^1.0.4",
"@deckdeckgo/inline-editor": "^1.2.0",
"@deckdeckgo/lazy-img": "^1.0.0",
"@deckdeckgo/math": "^1.0.1",
"@deckdeckgo/qrcode": "^1.0.0",
"@deckdeckgo/slide-aspect-ratio": "^1.0.0",
"@deckdeckgo/slide-author": "^1.0.0",
Expand Down
Loading