added stars widget

Author: unxok

README.md

@@ -1,96 +1,5 @@
-# Obsidian Sample Plugin
+# Better Properties
 
-This is a sample plugin for Obsidian (https://obsidian.md).
+Adds additional property types and configuration options to Obsidian's core **Properties View** plugin!
 
-This project uses TypeScript to provide type checking and documentation.
-The repo depends on the latest plugin API (obsidian.d.ts) in TypeScript Definition format, which contains TSDoc comments describing what it does.
-
-**Note:** The Obsidian API is still in early alpha and is subject to change at any time!
-
-This sample plugin demonstrates some of the basic functionality the plugin API can do.
-- Adds a ribbon icon, which shows a Notice when clicked.
-- Adds a command "Open Sample Modal" which opens a Modal.
-- Adds a plugin setting tab to the settings page.
-- Registers a global click event and output 'click' to the console.
-- Registers a global interval which logs 'setInterval' to the console.
-
-## First time developing plugins?
-
-Quick starting guide for new plugin devs:
-
-- Check if [someone already developed a plugin for what you want](https://obsidian.md/plugins)! There might be an existing plugin similar enough that you can partner up with.
-- Make a copy of this repo as a template with the "Use this template" button (login to GitHub if you don't see it).
-- Clone your repo to a local development folder. For convenience, you can place this folder in your `.obsidian/plugins/your-plugin-name` folder.
-- Install NodeJS, then run `npm i` in the command line under your repo folder.
-- Run `npm run dev` to compile your plugin from `main.ts` to `main.js`.
-- Make changes to `main.ts` (or create new `.ts` files). Those changes should be automatically compiled into `main.js`.
-- Reload Obsidian to load the new version of your plugin.
-- Enable plugin in settings window.
-- For updates to the Obsidian API run `npm update` in the command line under your repo folder.
-
-## Releasing new releases
-
-- Update your `manifest.json` with your new version number, such as `1.0.1`, and the minimum Obsidian version required for your latest release.
-- Update your `versions.json` file with `"new-plugin-version": "minimum-obsidian-version"` so older versions of Obsidian can download an older version of your plugin that's compatible.
-- Create new GitHub release using your new version number as the "Tag version". Use the exact version number, don't include a prefix `v`. See here for an example: https://github.com/obsidianmd/obsidian-sample-plugin/releases
-- Upload the files `manifest.json`, `main.js`, `styles.css` as binary attachments. Note: The manifest.json file must be in two places, first the root path of your repository and also in the release.
-- Publish the release.
-
-> You can simplify the version bump process by running `npm version patch`, `npm version minor` or `npm version major` after updating `minAppVersion` manually in `manifest.json`.
-> The command will bump version in `manifest.json` and `package.json`, and add the entry for the new version to `versions.json`
-
-## Adding your plugin to the community plugin list
-
-- Check the [plugin guidelines](https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines).
-- Publish an initial version.
-- Make sure you have a `README.md` file in the root of your repo.
-- Make a pull request at https://github.com/obsidianmd/obsidian-releases to add your plugin.
-
-## How to use
-
-- Clone this repo.
-- Make sure your NodeJS is at least v16 (`node --version`).
-- `npm i` or `yarn` to install dependencies.
-- `npm run dev` to start compilation in watch mode.
-
-## Manually installing the plugin
-
-- Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/your-plugin-id/`.
-
-## Improve code quality with eslint (optional)
-- [ESLint](https://eslint.org/) is a tool that analyzes your code to quickly find problems. You can run ESLint against your plugin to find common bugs and ways to improve your code. 
-- To use eslint with this project, make sure to install eslint from terminal:
-  - `npm install -g eslint`
-- To use eslint to analyze this project use this command:
-  - `eslint main.ts`
-  - eslint will then create a report with suggestions for code improvement by file and line number.
-- If your source code is in a folder, such as `src`, you can use eslint with this command to analyze all files in that folder:
-  - `eslint .\src\`
-
-## Funding URL
-
-You can include funding URLs where people who use your plugin can financially support it.
-
-The simple way is to set the `fundingUrl` field to your link in your `manifest.json` file:
-
-```json
-{
-    "fundingUrl": "https://buymeacoffee.com"
-}
-```
-
-If you have multiple URLs, you can also do:
-
-```json
-{
-    "fundingUrl": {
-        "Buy Me a Coffee": "https://buymeacoffee.com",
-        "GitHub Sponsor": "https://github.com/sponsors",
-        "Patreon": "https://www.patreon.com/"
-    }
-}
-```
-
-## API Documentation
-
-See https://github.com/obsidianmd/obsidian-api
+![preview](./preview.png)

manifest.json

@@ -1,8 +1,8 @@
 {
 	"id": "better-properties",
 	"name": "Better Properties",
-	"version": "1.0.0",
-	"minAppVersion": "0.15.0",
+	"version": "0.0.1",
+	"minAppVersion": "1.5.0",
 	"description": "Upgrades Obsidian properties with new types, features, and more!",
 	"author": "Unxok",
 	"authorUrl": "https://github.com/unxok",

package.json

@@ -1,12 +1,13 @@
 {
 	"name": "obsidian-better-properties",
-	"version": "1.0.0",
+	"version": "0.0.1",
 	"description": "Upgrades Obsidian properties with new types, features, and more!",
 	"main": "main.js",
 	"scripts": {
 		"dev": "vite build --watch --mode=development",
 		"build": "vite build",
-		"version": "node version-bump.mjs && git add manifest.json versions.json"
+		"version": "node version-bump.mjs && git add manifest.json versions.json",
+		"release": "git tag -a %npm_config_tag% -m '%npm_config_tag%' && git push origin %npm_config_tag%"
 	},
 	"keywords": [],
 	"author": "",

preview.png

@@ -47,6 +47,10 @@ export type PropertySettings = {
 	color: {};
 	markdown: {};
 	email: {};
+	stars: {
+		customIcon: string;
+		max: number;
+	};
 };
 
 // can't think of a way to have this typed properly but at least this avoids hard coding the keys somewhat
@@ -94,4 +98,8 @@ export const defaultPropertySettings: PropertySettings = {
 	color: {},
 	markdown: {},
 	email: {},
+	stars: {
+		customIcon: "star",
+		max: 5,
+	},
 };

src/libs/PropertySettings/index.ts

@@ -17,6 +17,7 @@ import {
 	defaultPropertySettings,
 	PropertySettings,
 } from "@/libs/PropertySettings";
+import { createStarsSettings } from "@/typeWidgets/Stars";
 
 export const addSettings = ({ menu, plugin, key }: MetadataAddItemProps) => {
 	menu.addItem((item) =>
@@ -57,7 +58,6 @@ class SettingsModal extends Modal {
 			// @ts-ignore TODO IDK why typescript doesn't like this
 			form[key] = { ...defaultValue, ...form[key] };
 		});
-		console.log("form after parse: ", form);
 		this.form = form;
 	}
 
@@ -133,9 +133,7 @@ class SettingsModal extends Modal {
 		});
 
 		switch (
-			typeKey.slice(
-				typeWidgetPrefix.length
-			) as keyof typeof typeKeySuffixes
+			typeKey.slice(typeWidgetPrefix.length) as keyof PropertySettings
 		) {
 			case "slider":
 				return createSliderSettings(
@@ -163,6 +161,13 @@ class SettingsModal extends Modal {
 					(key, value) => this.updateForm("button", key, value),
 					this.plugin
 				);
+			case "stars":
+				return createStarsSettings(
+					contentEl,
+					this.form["stars"],
+					(key, value) => this.updateForm("stars", key, value),
+					this.plugin
+				);
 			default:
 				new Setting(contentEl)
 					.setName("Non customizable type")
@@ -175,7 +180,6 @@ class SettingsModal extends Modal {
 	async onClose(): Promise<void> {
 		const { plugin, property, form } = this;
 		const key = property.toLowerCase();
-		console.log("about to save form: ", form);
 		await plugin.updateSettings((prev) => ({
 			...prev,
 			propertySettings: { ...prev.propertySettings, [key]: form },

src/libs/utils/augmentMedataMenu/addSettings/index.ts

@@ -28,3 +28,16 @@ export const getButtonStyledClass = (
 	if (style === "warning") return "mod-warning";
 	return "";
 };
+
+export const clampNumber = (
+	num: number,
+	min: number,
+	max: number,
+	nonInclusive?: boolean
+) => {
+	const underMin = nonInclusive ? num < min : num <= min;
+	if (underMin) return min;
+	const overMax = nonInclusive ? num > max : num >= max;
+	if (overMax) return max;
+	return num;
+};

src/libs/utils/pure/index.ts

@@ -194,12 +194,6 @@ export default class BetterProperties extends Plugin {
 	}
 }
 
-type PatchedMetadataEditor = MetadataEditor & {
-	toggleHiddenButton: HTMLDivElement;
-	showHiddenProperties: boolean;
-	toggleHiddenProperties(): void;
-};
-
 const patchMenu = (plugin: BetterProperties) => {
 	const removePatch = around(Menu.prototype, {
 		showAtMouseEvent(old) {
@@ -236,6 +230,12 @@ const patchMenu = (plugin: BetterProperties) => {
 	plugin.register(removePatch);
 };
 
+export type PatchedMetadataEditor = MetadataEditor & {
+	toggleHiddenButton: HTMLDivElement;
+	showHiddenProperties: boolean;
+	toggleHiddenProperties(): void;
+};
+
 const patchMetdataEditor = (plugin: BetterProperties) => {
 	const view = plugin.app.viewRegistry.viewByType["markdown"]({
 		containerEl: createDiv(),

src/main.ts

@@ -39,14 +39,10 @@ export const ButtonWidget: CustomTypeWidget = {
 
 		btn.buttonEl.setAttribute("style", "margin-top: 0px;");
 
-		btn.buttonEl.classList.add(getButtonStyledClass(style));
-
-		// if (style === "accent") btn.setCta();
-		// if (style === "warning") btn.setWarning();
-		// if (style === "destructive")
-		// 	btn.buttonEl.classList.add("mod-destructive");
-		// if (style === "muted") btn.buttonEl.classList.add("mod-muted");
-		// if (style === "ghost") btn.buttonEl.classList.add("clickable-icon");
+		const className = getButtonStyledClass(style);
+		if (className) {
+			btn.buttonEl.classList.add(className);
+		}
 		if (bgColor) {
 			btn.buttonEl.style.backgroundColor = bgColor;
 		}
@@ -179,7 +175,11 @@ export const createButtonSettings = (
 		.addButton((cmp) =>
 			cmp
 				.setButtonText("preview")
-				.setClass(getButtonStyledClass(style))
+				.then((cmp) => {
+					const cn = getButtonStyledClass(style);
+					if (!cn) return;
+					cmp.setClass(cn);
+				})
 				.then((cmp) => (stylePreviewBtn = cmp))
 		);
 

src/typeWidgets/Button/index.ts

@@ -0,0 +1,107 @@
+import { ButtonComponent, DropdownComponent, setIcon, Setting } from "obsidian";
+import { CustomTypeWidget } from "..";
+import { clampNumber, getButtonStyledClass } from "@/libs/utils/pure";
+import { IconSuggest } from "@/classes/IconSuggest";
+import { TextColorComponent } from "@/classes/TextColorComponent";
+import { createSection } from "@/libs/utils/setting";
+import BetterProperties from "@/main";
+import {
+	defaultPropertySettings,
+	PropertySettings,
+} from "@/libs/PropertySettings";
+
+export const StarsWidget: CustomTypeWidget = {
+	type: "stars",
+	icon: "star",
+	default: () => 0,
+	name: () => "Stars",
+	validate: (v) => !Number.isNaN(Number(v)),
+	render: (plugin, el, data, ctx) => {
+		const { customIcon, max } = plugin.settings.propertySettings[
+			data.key.toLowerCase()
+		]?.["stars"] ?? {
+			...defaultPropertySettings["stars"],
+		};
+
+		const container = el.createDiv({
+			cls: "metadata-input-longtext",
+			attr: {
+				"data-count": data.value?.toString() ?? "1",
+			},
+		});
+
+		const min = 0;
+
+		const count = clampNumber(Number(data.value), min, max);
+		const starEls: HTMLElement[] = [];
+
+		for (let i = 1; i < max + 1; i++) {
+			const span = container.createSpan({
+				cls: "clickable-icon better-properties-inline-flex",
+				attr: {
+					"aria-label": i.toString(),
+				},
+			});
+			starEls.push(span);
+			setIcon(span, customIcon);
+
+			if (i <= count) {
+				span.classList.add("better-properties-svg-fill");
+			}
+
+			span.addEventListener("click", () => {
+				const existingCount = clampNumber(
+					Number(container.getAttribute("data-count")),
+					min,
+					max
+				);
+				const newCount = existingCount !== i ? i : i - 1;
+				container.setAttribute("data-count", newCount.toString());
+				starEls.forEach((el, k) => {
+					if (k + 1 <= newCount) {
+						return el.classList.add("better-properties-svg-fill");
+					}
+					el.classList.remove("better-properties-svg-fill");
+				});
+				ctx.onChange(newCount);
+			});
+		}
+	},
+};
+
+export const createStarsSettings = (
+	el: HTMLElement,
+	form: PropertySettings["stars"],
+	updateForm: <T extends keyof PropertySettings["stars"]>(
+		key: T,
+		value: PropertySettings["stars"][T]
+	) => void,
+	plugin: BetterProperties
+	// defaultOpen: boolean
+) => {
+	const { customIcon, max } = form;
+
+	const { content } = createSection(el, "Button", true);
+
+	new Setting(content)
+		.setName("Override star icon")
+		.setDesc("Set a custom icon to show in place of the default stars.")
+		.addText((cmp) =>
+			cmp
+				.setValue(customIcon)
+				.onChange((v) => updateForm("customIcon", v))
+				.then((cmp) => new IconSuggest(plugin.app, cmp))
+		);
+
+	new Setting(content)
+		.setName("Count")
+		.setDesc("How many stars to display.")
+		.addText((cmp) =>
+			cmp
+				.setValue(max.toString())
+				.onChange((v) => updateForm("max", Number(v)))
+				.then((cmp) => {
+					cmp.inputEl.setAttribute("type", "number");
+				})
+		);
+};