Skip to content

Commit 4dae65d

Browse files
feat: enable sticky file headers by default
Update the stickyFileHeaders default value to `true` so that it is enabled by default. Also correct the name of this option in the documentation by adding the missing trailing "s".
1 parent 7d4a5dc commit 4dae65d

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ draw(): void
156156
synchronisedScroll(): void
157157
fileListToggle(startVisible: boolean): void
158158
highlightCode(): void
159-
stickyFileHeader(): void
159+
stickyFileHeaders(): void
160160
```
161161

162162
### Diff2HtmlUI Configuration
@@ -166,7 +166,7 @@ stickyFileHeader(): void
166166
- `fileListToggle`: allow the file summary list to be toggled: `true` or `false`, default is `true`
167167
- `fileListStartVisible`: choose if the file summary list starts visible: `true` or `false`, default is `false`
168168
- `fileContentToggle`: allow each file contents to be toggled: `true` or `false`, default is `true`
169-
- `stickyFileHeader`: make file headers sticky: `true` or `false`, default is `false`
169+
- `stickyFileHeaders`: make file headers sticky: `true` or `false`, default is `true`
170170
- [All the options](#diff2html-configuration) from Diff2Html are also valid configurations in Diff2HtmlUI
171171

172172
### Diff2HtmlUI Browser

src/ui/js/diff2html-ui-base.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ export const defaultDiff2HtmlUIConfig = {
3232
*/
3333
smartSelection: true,
3434
fileContentToggle: true,
35-
stickyFileHeaders: false,
35+
stickyFileHeaders: true,
3636
};
3737

3838
export class Diff2HtmlUI {

0 commit comments

Comments
 (0)