Skip to content
This repository was archived by the owner on Feb 6, 2024. It is now read-only.

Commit 8b0f0b3

Browse files
doc(#115): add lineNumbers attribute to documentation
1 parent c1821b5 commit 8b0f0b3

File tree

2 files changed

+18
-0
lines changed

2 files changed

+18
-0
lines changed

docs/docs/components/app-components-highlight-code/app-components-highlight-code.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@ The `<deckgo-highlight-code/>` expose the following properties:
7373
| `hideAnchor` | `hide-anchor` | Set this attribute to `false` in case you would like to actually display the anchor value too | `boolean` | `true` |
7474
| `language` | `language` | Define the language to be used for the syntax highlighting. The list of [supported languages](https://prismjs.com/#languages-list) is defined by [Prism.js](https://prismjs.com/#languages-list) | `string` | `'javascript'` |
7575
| `highlightLines` | `highlight-lines` | If you wish to highlight some lines of your code. The lines number should be provided as number separated with coma and group separated with space. For example: "3,5 8,9 13,13 14,17" | `string` | |
76+
| `lineNumbers` | `line-numbers` | Display the number of the lines of code | `boolean` | `false` |
7677
| `editable` | `editable` | In case you would like to set the code component as being editable. | `boolean` | `false` |
7778

7879
### Styling

docs/src/app/pages/docs/components/app-components-highlight-code/app-components-highlight-code.tsx

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,13 @@ export class AppComponentsHighlightCode {
130130
<td></td>
131131
</tr>
132132
<tr>
133+
<td><code>lineNumbers</code></td>
134+
<td><code>line-numbers</code></td>
135+
<td>Display the number of the lines of code</td>
136+
<td><code>boolean</code></td>
137+
<td><code>false</code></td>
138+
</tr>
139+
<tr>
133140
<td><code>editable</code></td>
134141
<td><code>editable</code></td>
135142
<td>In case you would like to set the code component as being editable.</td>
@@ -198,6 +205,16 @@ export class AppComponentsHighlightCode {
198205
<td>The background of the lines you wish to highlight</td>
199206
</tr>
200207
<tr>
208+
<td>--deckgo-highlight-code-line-divider</td>
209+
<td>#999999</td>
210+
<td>The color of the line numbers</td>
211+
</tr>
212+
<tr>
213+
<td>--deckgo-highlight-code-line-number</td>
214+
<td>#999999</td>
215+
<td>The color of the divider between line numbers and code</td>
216+
</tr>
217+
<tr>
201218
<td>--deckgo-highlight-code-line-padding</td>
202219
<td></td>
203220
<td>A padding for each lines you wish to highlight</td>

0 commit comments

Comments
 (0)