Skip to content

Commit c82d04f

Browse files
splitbrainsplitbrain
committed
some small fixes and readme rebuilds
1 parent 7ccfc4c commit c82d04f

File tree

12 files changed

+87
-41
lines changed

12 files changed

+87
-41
lines changed

‎.dockerignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,4 @@
88
!/frontend/src/components/*/readme.md
99
!/meh
1010
!/README.md
11+
!/meh.svg

‎frontend/src/components.d.ts‎

Lines changed: 50 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,17 @@ import { HTMLStencilElement, JSXBase } from "@stencil/core/internal";
88
export namespace Components {
99
interface MehComments {
1010
/**
11-
* The base URL for where the meh system is hosted If not provided, defaults to same origin
11+
* The base URL for where the meh system is hosted If not provided, attempts to detect from script tag
1212
*/
1313
"backend": string;
1414
/**
1515
* Custom translations object that overrides default and loaded translations This allows users to provide their own translations directly
1616
*/
1717
"customTranslations": string | Partial<typeof this.defaultTranslations>;
18+
/**
19+
* URL to an external stylesheet to be injected into the shadow DOM
20+
*/
21+
"externalStyles": string;
1822
/**
1923
* The language code for translations If not provided, defaults to 'en'
2024
*/
@@ -30,13 +34,17 @@ export namespace Components {
3034
}
3135
interface MehCount {
3236
/**
33-
* The base URL for where the meh system is hosted If not provided, defaults to same origin
37+
* The base URL for where the meh system is hosted If not provided, attempts to detect from script tag
3438
*/
3539
"backend": string;
3640
/**
3741
* Custom translations object that overrides default and loaded translations This allows users to provide their own translations directly
3842
*/
3943
"customTranslations": string | Partial<typeof this.defaultTranslations>;
44+
/**
45+
* URL to an external stylesheet to be injected into the shadow DOM
46+
*/
47+
"externalStyles": string;
4048
/**
4149
* The language code for translations If not provided, defaults to 'en'
4250
*/
@@ -56,13 +64,17 @@ export namespace Components {
5664
}
5765
interface MehForm {
5866
/**
59-
* The base URL for where the meh system is hosted If not provided, defaults to same origin
67+
* The base URL for where the meh system is hosted If not provided, attempts to detect from script tag
6068
*/
6169
"backend": string;
6270
/**
6371
* Custom translations object that overrides default and loaded translations This allows users to provide their own translations directly
6472
*/
6573
"customTranslations": string | Partial<typeof this.defaultTranslations>;
74+
/**
75+
* URL to an external stylesheet to be injected into the shadow DOM
76+
*/
77+
"externalStyles": string;
6678
/**
6779
* The language code for translations If not provided, defaults to 'en'
6880
*/
@@ -78,13 +90,17 @@ export namespace Components {
7890
}
7991
interface MehLogin {
8092
/**
81-
* The base URL for where the meh system is hosted If not provided, defaults to same origin
93+
* The base URL for where the meh system is hosted If not provided, attempts to detect from script tag
8294
*/
8395
"backend": string;
8496
/**
8597
* Custom translations object that overrides default and loaded translations This allows users to provide their own translations directly
8698
*/
8799
"customTranslations": string | Partial<typeof this.defaultTranslations>;
100+
/**
101+
* URL to an external stylesheet to be injected into the shadow DOM
102+
*/
103+
"externalStyles": string;
88104
/**
89105
* The language code for translations If not provided, defaults to 'en'
90106
*/
@@ -96,13 +112,17 @@ export namespace Components {
96112
}
97113
interface MehMastodon {
98114
/**
99-
* The base URL for where the meh system is hosted If not provided, defaults to same origin
115+
* The base URL for where the meh system is hosted If not provided, attempts to detect from script tag
100116
*/
101117
"backend": string;
102118
/**
103119
* Custom translations object that overrides default and loaded translations This allows users to provide their own translations directly
104120
*/
105121
"customTranslations": string | Partial<typeof this.defaultTranslations>;
122+
/**
123+
* URL to an external stylesheet to be injected into the shadow DOM
124+
*/
125+
"externalStyles": string;
106126
/**
107127
* The language code for translations If not provided, defaults to 'en'
108128
*/
@@ -159,13 +179,17 @@ declare global {
159179
declare namespace LocalJSX {
160180
interface MehComments {
161181
/**
162-
* The base URL for where the meh system is hosted If not provided, defaults to same origin
182+
* The base URL for where the meh system is hosted If not provided, attempts to detect from script tag
163183
*/
164184
"backend"?: string;
165185
/**
166186
* Custom translations object that overrides default and loaded translations This allows users to provide their own translations directly
167187
*/
168188
"customTranslations"?: string | Partial<typeof this.defaultTranslations>;
189+
/**
190+
* URL to an external stylesheet to be injected into the shadow DOM
191+
*/
192+
"externalStyles"?: string;
169193
/**
170194
* The language code for translations If not provided, defaults to 'en'
171195
*/
@@ -181,13 +205,17 @@ declare namespace LocalJSX {
181205
}
182206
interface MehCount {
183207
/**
184-
* The base URL for where the meh system is hosted If not provided, defaults to same origin
208+
* The base URL for where the meh system is hosted If not provided, attempts to detect from script tag
185209
*/
186210
"backend"?: string;
187211
/**
188212
* Custom translations object that overrides default and loaded translations This allows users to provide their own translations directly
189213
*/
190214
"customTranslations"?: string | Partial<typeof this.defaultTranslations>;
215+
/**
216+
* URL to an external stylesheet to be injected into the shadow DOM
217+
*/
218+
"externalStyles"?: string;
191219
/**
192220
* The language code for translations If not provided, defaults to 'en'
193221
*/
@@ -207,13 +235,17 @@ declare namespace LocalJSX {
207235
}
208236
interface MehForm {
209237
/**
210-
* The base URL for where the meh system is hosted If not provided, defaults to same origin
238+
* The base URL for where the meh system is hosted If not provided, attempts to detect from script tag
211239
*/
212240
"backend"?: string;
213241
/**
214242
* Custom translations object that overrides default and loaded translations This allows users to provide their own translations directly
215243
*/
216244
"customTranslations"?: string | Partial<typeof this.defaultTranslations>;
245+
/**
246+
* URL to an external stylesheet to be injected into the shadow DOM
247+
*/
248+
"externalStyles"?: string;
217249
/**
218250
* The language code for translations If not provided, defaults to 'en'
219251
*/
@@ -229,13 +261,17 @@ declare namespace LocalJSX {
229261
}
230262
interface MehLogin {
231263
/**
232-
* The base URL for where the meh system is hosted If not provided, defaults to same origin
264+
* The base URL for where the meh system is hosted If not provided, attempts to detect from script tag
233265
*/
234266
"backend"?: string;
235267
/**
236268
* Custom translations object that overrides default and loaded translations This allows users to provide their own translations directly
237269
*/
238270
"customTranslations"?: string | Partial<typeof this.defaultTranslations>;
271+
/**
272+
* URL to an external stylesheet to be injected into the shadow DOM
273+
*/
274+
"externalStyles"?: string;
239275
/**
240276
* The language code for translations If not provided, defaults to 'en'
241277
*/
@@ -247,13 +283,17 @@ declare namespace LocalJSX {
247283
}
248284
interface MehMastodon {
249285
/**
250-
* The base URL for where the meh system is hosted If not provided, defaults to same origin
286+
* The base URL for where the meh system is hosted If not provided, attempts to detect from script tag
251287
*/
252288
"backend"?: string;
253289
/**
254290
* Custom translations object that overrides default and loaded translations This allows users to provide their own translations directly
255291
*/
256292
"customTranslations"?: string | Partial<typeof this.defaultTranslations>;
293+
/**
294+
* URL to an external stylesheet to be injected into the shadow DOM
295+
*/
296+
"externalStyles"?: string;
257297
/**
258298
* The language code for translations If not provided, defaults to 'en'
259299
*/

‎frontend/src/components/meh-comments/meh-comments.tsx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ export class MehComments {
2222
* The base URL for where the meh system is hosted
2323
* If not provided, attempts to detect from script tag
2424
*/
25-
@Prop() backend: string = '';
25+
@Prop({ mutable: true }) backend: string = '';
2626

2727
/**
2828
* The site identifier to use

‎frontend/src/components/meh-comments/readme.md‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,14 @@ Typically, the component will only display approved comments. To access moderati
2626

2727
## Properties
2828

29-
| Property | Attribute | Description | Type | Default |
30-
| -------------------- | --------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
31-
| `backend` | `backend` | The base URL for where the meh system is hosted If not provided, defaults to same origin | `string` | `''` |
32-
| `customTranslations` | `custom-translations` | Custom translations object that overrides default and loaded translations This allows users to provide their own translations directly | `string \| { noComments?: string; loadingComments?: string; errorLoading?: string; postedOn?: string; by?: string; approve?: string; reject?: string; delete?: string; edit?: string; spam?: string; confirmDelete?: string; }` | `''` |
33-
| `language` | `language` | The language code for translations If not provided, defaults to 'en' | `string` | `'en'` |
34-
| `post` | `post` | The post path to fetch comments for If not provided, defaults to the current page path | `string` | `undefined` |
35-
| `site` | `site` | The site identifier to use If not provided, defaults to 'meh' | `string` | `'meh'` |
29+
| Property | Attribute | Description | Type | Default |
30+
| -------------------- | --------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
31+
| `backend` | `backend` | The base URL for where the meh system is hosted If not provided, attempts to detect from script tag | `string` | `''` |
32+
| `customTranslations` | `custom-translations` | Custom translations object that overrides default and loaded translations This allows users to provide their own translations directly | `string \| { noComments?: string; loadingComments?: string; errorLoading?: string; approve?: string; reject?: string; delete?: string; edit?: string; spam?: string; confirmDelete?: string; }` | `''` |
33+
| `externalStyles` | `external-styles` | URL to an external stylesheet to be injected into the shadow DOM | `string` | `''` |
34+
| `language` | `language` | The language code for translations If not provided, defaults to 'en' | `string` | `'en'` |
35+
| `post` | `post` | The post path to fetch comments for If not provided, defaults to the current page path | `string` | `undefined` |
36+
| `site` | `site` | The site identifier to use If not provided, defaults to 'meh' | `string` | `'meh'` |
3637

3738

3839
----------------------------------------------

‎frontend/src/components/meh-count/meh-count.tsx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ export class MehCount {
2020
* The base URL for where the meh system is hosted
2121
* If not provided, attempts to detect from script tag
2222
*/
23-
@Prop() backend: string = '';
23+
@Prop({ mutable: true }) backend: string = '';
2424

2525
/**
2626
* The site identifier to use

‎frontend/src/components/meh-count/readme.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,9 @@ A common use case is to show comment counts in a list of blog posts:
4141

4242
| Property | Attribute | Description | Type | Default |
4343
| -------------------- | --------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
44-
| `backend` | `backend` | The base URL for where the meh system is hosted If not provided, defaults to same origin | `string` | `''` |
44+
| `backend` | `backend` | The base URL for where the meh system is hosted If not provided, attempts to detect from script tag | `string` | `''` |
4545
| `customTranslations` | `custom-translations` | Custom translations object that overrides default and loaded translations This allows users to provide their own translations directly | `string \| { noComments?: string; oneComment?: string; multipleComments?: string; loadingComments?: string; errorLoading?: string; }` | `''` |
46+
| `externalStyles` | `external-styles` | URL to an external stylesheet to be injected into the shadow DOM | `string` | `''` |
4647
| `language` | `language` | The language code for translations If not provided, defaults to 'en' | `string` | `'en'` |
4748
| `numonly` | `numonly` | When set to true, only the number will be displayed without any text | `boolean` | `false` |
4849
| `post` | `post` | The post path to fetch comment count for If not provided, defaults to the current page path | `string` | `undefined` |

‎frontend/src/components/meh-form/meh-form.tsx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ export class MehForm {
2323
* The base URL for where the meh system is hosted
2424
* If not provided, attempts to detect from script tag
2525
*/
26-
@Prop() backend: string = '';
26+
@Prop({ mutable: true }) backend: string = '';
2727

2828
/**
2929
* The site identifier to use

0 commit comments

Comments
 (0)