Skip to content

Build your personal knowledge base with Trilium Notes

client: fix some issues

Adorian Doran2af27f735cb4
diff --git a/apps/client/src/widgets/attribute_widgets/attribute_detail.tsx b/apps/client/src/widgets/attribute_widgets/attribute_detail.tsx
index d3a2bcfe62..93a67368d2 100644
--- a/apps/client/src/widgets/attribute_widgets/attribute_detail.tsx
+++ b/apps/client/src/widgets/attribute_widgets/attribute_detail.tsx
@@ -49,8 +49,8 @@ export interface AttributeDetailOpts {
parent?: HTMLElement;
hideMultiplicity?: boolean;
/**
- * Leaves out the inheritable and promoted toggles, for a host that decides both itself: a
- * collection arranging what its items show, where every attribute is inheritable and promoted.
+ * Leaves out the inheritable and promoted toggles. For a host that sets both itself, such as a
+ * collection whose attributes are all inheritable and promoted.
*/
hideInheritance?: boolean;
/**
diff --git a/apps/client/src/widgets/collections/promoted_attributes.ts b/apps/client/src/widgets/collections/promoted_attributes.ts
index 400e752bc3..b5960a9699 100644
--- a/apps/client/src/widgets/collections/promoted_attributes.ts
+++ b/apps/client/src/widgets/collections/promoted_attributes.ts
@@ -121,10 +121,8 @@ export function renameAttributeInSubtree(
}
/**
- * Deletes an attribute from the collection and everything under it.
- *
- * Quietly: the attribute leaving the list and the items is what reports it, and a toast over a
- * dialog the reader is still working in reads as something else having happened.
+ * Deletes an attribute from the collection and everything under it. Silent: the attribute leaving
+ * the list and the items reports it, and a toast over the dialog reads as something else.
*/
export function deleteAttributeInSubtree(
parentNoteId: string, type: "label" | "relation", name: string
diff --git a/apps/client/src/widgets/react/PromotedAttributesCard.css b/apps/client/src/widgets/react/PromotedAttributesCard.css
index 5006d5c4fa..aa2ae89d5f 100644
--- a/apps/client/src/widgets/react/PromotedAttributesCard.css
+++ b/apps/client/src/widgets/react/PromotedAttributesCard.css
@@ -1,4 +1,5 @@
.tn-card.promoted-attributes-card {
+ /* Clears the card above it in the dialogs that stack the two. */
margin-block-start: 24px;
/* The name takes the free space, pushing the edit button and the toggle to the trailing edge. */
diff --git a/apps/client/src/widgets/react/PromotedAttributesCard.tsx b/apps/client/src/widgets/react/PromotedAttributesCard.tsx
index d638155807..4411ab802c 100644
--- a/apps/client/src/widgets/react/PromotedAttributesCard.tsx
+++ b/apps/client/src/widgets/react/PromotedAttributesCard.tsx
@@ -22,10 +22,10 @@ import { useTriliumEvent } from "./hooks";
import Icon from "./Icon";
import { type SortableItem, SortableCard } from "./SortableCard";
-/** What each kind of definition is called and drawn as, as the editor picks it by. */
+/** Each kind of definition by name, holding the title and icon `AttributeDetail` lists it with. */
const TYPES = new Map(DEFINITION_TYPES.map((type) => [ type.value, type ]));
-/** What a definition naming no kind holds, which is what the editor starts one as. */
+/** The kind a definition naming none is drawn as, which is what a new one is created as. */
const DEFAULT_TYPE = TYPES.get("text") ?? DEFINITION_TYPES[0];
/** The definition a new attribute starts from, which the reader names in the editor. */
@@ -53,22 +53,22 @@ export interface PromotedAttributesCardProps {
/**
* The promoted attributes a collection shows on its items, in the order they are shown.
*
- * The reader reorders the list, turns an attribute off without deleting it, and edits or creates a
- * definition through the attribute editor. The definitions belong to `note`; the order and what is
- * hidden belong to the caller, which stores whatever `onChange` reports.
+ * Entries are reordered, hidden without being deleted, edited or deleted through the attribute
+ * editor, and created from the button at the foot. `note` carries the definitions; `onChange`
+ * reports the order and what is hidden, which the caller stores.
*/
export default function PromotedAttributesCard({
heading, instruction, note, settings, ignored, onChange
}: PromotedAttributesCardProps) {
const [ shown, setShown ] = useState(() => resolvePromotedAttributes(note, settings, ignored));
const [ detail, setDetail ] = useState<AttributeDetailOpts | null>(null);
- /** What the editor last reported, which is what a save writes. */
+ /** The definition the editor last reported, which `save` writes. */
const edited = useRef<Attribute>();
- /** What the editor was handed, against which a renamed definition is recognised. */
+ /** The definition the editor was handed, which `save` compares against to spot a rename. */
const original = useRef<Attribute>();
- // A definition created, renamed or deleted here arrives as an attribute change like any other,
- // and the order the reader has put the rest in is kept across it.
+ // A definition created, renamed or deleted here arrives as an attribute change. Resolving
+ // against the current list is what keeps the order of the rest.
useTriliumEvent("entitiesReloaded", ({ loadResults }) => {
const affects = loadResults.getAttributeRows()
.some((attribute) => attributes.isAffecting(attribute, note));
@@ -124,8 +124,8 @@ export default function PromotedAttributesCard({
y: event?.pageY ?? 150,
focus: attribute ? undefined : "name",
hideMultiplicity: true,
- // Everything arranged here is inheritable and promoted, which is what puts it on the
- // items: the reader picks what an attribute holds, not how it reaches them.
+ // Every attribute listed here is inheritable and promoted already, so the two toggles
+ // would only offer a way to take it off the list.
hideInheritance: true
});
}, []);
@@ -162,10 +162,8 @@ export default function PromotedAttributesCard({
}, [ note ]);
/**
- * Takes the definition away, and with it the values written against it.
- *
- * Unlike deleting the definition from the attributes panel, which leaves every item still
- * carrying its value under a name nothing describes any more.
+ * Deletes the definition and every value written against it. Deleting it from the attributes
+ * panel instead leaves the items carrying values no definition describes.
*/
const erase = useCallback(async (definitionName: string) => {
const [ type, name ] = definitionName.split(":", 2) as [ "label" | "relation", string ];
@@ -182,7 +180,7 @@ export default function PromotedAttributesCard({
}
}, [ erase ]);
- /** Asks before deleting, since the values on the items go with the definition. */
+ /** Confirms first: the values on the items are deleted with the definition. */
const confirmErase = useCallback(async (attribute: PromotedAttribute) => {
const confirmed = await dialog.confirm(
t("promoted_attributes.delete_confirmation", { name: attribute.title }));
@@ -273,7 +271,7 @@ export default function PromotedAttributesCard({
);
}
-/** What an attribute holds, as the editor lists the kinds. */
+/** The kind entry for an attribute: its `labelType`, or the relation kind for a relation. */
function typeOf(attribute: PromotedAttribute) {
const kind = attribute.type === "relation"
? RELATION_DEFINITION_TYPE