Skip to content

Offline, privacy-first grammar checker. Fast, open-source, Rust-powered

feat: improved layout and style of config panel

Elijah Potter14fb34eb23e9
diff --git a/src/harper/HarperContext.tsx b/src/harper/HarperContext.tsx
index f99e9f3bd..c1a6af231 100644
--- a/src/harper/HarperContext.tsx
+++ b/src/harper/HarperContext.tsx
@@ -50,6 +50,17 @@ export function useLinter(): Linter {
return data.linter;
}
+export function useLintDescriptions(): Record<string, string> {
+ const [data] = useContext(harperContext);
+ const [descriptions, setDescriptions] = useState({});
+
+ useEffect(() => {
+ data.linter.getLintDescriptions().then(setDescriptions);
+ }, [data]);
+
+ return descriptions;
+}
+
export function useDefaultLintConfig(): LintConfig {
const [data] = useContext(harperContext);
const [defaultConfig, setDefaultConfig] = useState({});
diff --git a/src/harper/LintSettingList.tsx b/src/harper/LintSettingList.tsx
index bcd0cc4f5..71d91ab3c 100644
--- a/src/harper/LintSettingList.tsx
+++ b/src/harper/LintSettingList.tsx
@@ -1,15 +1,21 @@
import React, { useEffect } from 'react';
-import { useDefaultLintConfig, useLinterConfig } from './HarperContext';
+import {
+ useDefaultLintConfig,
+ useLintDescriptions,
+ useLinterConfig,
+} from './HarperContext';
import LintSettingRow from './LintSettingRow';
export default function LintSettingList() {
const [lintConfig, setLintConfig] = useLinterConfig();
const defaultConfig = useDefaultLintConfig();
+ const descriptions = useLintDescriptions();
return Object.entries(lintConfig).map(([key, value]) => (
<LintSettingRow
key={key}
name={key}
+ description={descriptions[key]}
value={value}
defaultValue={defaultConfig[key]!}
setValue={(newValue) =>
diff --git a/src/harper/LintSettingRow.tsx b/src/harper/LintSettingRow.tsx
index 672040556..2f9727526 100644
--- a/src/harper/LintSettingRow.tsx
+++ b/src/harper/LintSettingRow.tsx
@@ -7,8 +7,10 @@ export default function LintSettingRow({
value,
defaultValue,
setValue,
+ description,
}: {
name: string;
+ description: string;
value: boolean | undefined;
defaultValue: boolean;
setValue: (newValue: boolean | undefined) => void;
@@ -26,8 +28,16 @@ export default function LintSettingRow({
{({ className }) => (
<div className={`${className} harper-lint-config-row`}>
<h3>{title}</h3>
+ <p>{description}</p>
<CheckboxControl
+ label={
+ value == null
+ ? `Default (${defaultValue ? 'Enabled' : 'Disabled'})`
+ : value
+ ? 'Enabled'
+ : 'Disabled'
+ }
onChange={(val) => setValue(val)}
checked={value ?? defaultValue}
></CheckboxControl>
diff --git a/src/harper/index.css b/src/harper/index.css
index dfda74d39..f1a41147c 100644
--- a/src/harper/index.css
+++ b/src/harper/index.css
@@ -5,13 +5,13 @@
}
.harper-lint-config-row {
- display: flex;
- flex-direction: row;
- justify-content: space-between;
- align-items: center;
padding: 6px;
}
+.harper-lint-config-row > h3{
+ font-weight: bold;
+}
+
.harper-popover > div > button {
width: 100%;
margin-top: 6px;