MirrorMirror
/
funkwhale
mirror of https://dev.funkwhale.audio/funkwhale/funkwhale.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

fix(docs): replace Ui with UI

This commit is contained in:
jon r 2025-02-22 22:42:35 +01:00
parent 647cf045cd
commit 841bad228d
8 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/developer/contribute/frontend.md
View File

@ -22,7 +22,7 @@ Make sure you have no add-ons in your browser that mess with the DOM. The best w
<--! TODO: Mermaid diagrams --> <--! TODO: Mermaid diagrams -->
### Ui styles ### UI styles
```mermaid ```mermaid
graph TD graph TD
@ -49,7 +49,7 @@ graph TD
## Components ## Components
Start the **Ui Live Docs** (vitepress) and follow the link: Start the **UI Live Docs** (vitepress) and follow the link:
```sh ```sh
yarn dev:docs yarn dev:docs
@ -57,7 +57,7 @@ yarn dev:docs
- Example: [Button component in the live docs](http://localhost:5173/components/ui/button) - Example: [Button component in the live docs](http://localhost:5173/components/ui/button)
- Find more details about the Ui library and [how to contributein the live docs](http://localhost:5173/contributing) - Find more details about the UI library and [how to contributein the live docs](http://localhost:5173/contributing)
## Testing ## Testing

2
front/ui-docs/.vitepress/config.ts
View File

@ -1,7 +1,7 @@
import { defineConfig } from 'vitepress' import { defineConfig } from 'vitepress'
export default defineConfig({ export default defineConfig({
title: 'Funkwhale Ui', title: 'Funkwhale UI',
cleanUrls: true, cleanUrls: true,
cacheDir: './.vitepress/.vite', cacheDir: './.vitepress/.vite',
themeConfig: { themeConfig: {

2
front/ui-docs/components/ui/button.md
View File

@ -295,7 +295,7 @@ You can force an active state by passing an `aria-pressed` prop.
**Examples:** **Examples:**
- Toggle a remote property - Toggle a remote property
- Open/close a section in the Ui - Open/close a section in the UI
- Toolbar buttons that toggle through many options such as "Paragraph/Heading/List" - Toolbar buttons that toggle through many options such as "Paragraph/Heading/List"
**Use the [Toggle component](toggle) (a.k.a. switch)** **Use the [Toggle component](toggle) (a.k.a. switch)**

2
front/ui-docs/components/ui/layout.md
View File

@ -20,7 +20,7 @@ import Layout from "~/components/ui/Layout.vue"
# Layout # Layout
CSS provides [four methods to arrange items in a container](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_grid_layout/Relationship_of_grid_layout_with_other_layout_methods): Flow, Columns, Flex and Grid. To make typical alignment tasks in the Funkwhale Ui easier, we have created a few useful presets. CSS provides [four methods to arrange items in a container](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_grid_layout/Relationship_of_grid_layout_with_other_layout_methods): Flow, Columns, Flex and Grid. To make typical alignment tasks in the Funkwhale UI easier, we have created a few useful presets.
By default, the items have a 32px gap. You can [change it with the `gap-x` prop](#gap-x-set-the-gap-to-one-of-the-defaults). By default, the items have a 32px gap. You can [change it with the `gap-x` prop](#gap-x-set-the-gap-to-one-of-the-defaults).

2
front/ui-docs/components/ui/popover.md
View File

@ -91,7 +91,7 @@ This component has severe usability issues and cannot be used as-is.
--- ---
Common Ui libraries in the Vue ecosystem such as vuetify or shadcn-vue all implement these features. It may be prudent to use their components. Common UI libraries in the Vue ecosystem such as vuetify or shadcn-vue all implement these features. It may be prudent to use their components.
::: tip Quick mitigation tactics: ::: tip Quick mitigation tactics:

4
front/ui-docs/contributing.md
View File

@ -12,7 +12,7 @@ docs](https://vitepress.dev/guide/using-vue#vs-code-intellisense-support):
"vue.server.includeLanguages": ["vue", "markdown"] "vue.server.includeLanguages": ["vue", "markdown"]
``` ```
## Adding new Ui components ## Adding new UI components
::: tip Prerequisites ::: tip Prerequisites
@ -20,7 +20,7 @@ docs](https://vitepress.dev/guide/using-vue#vs-code-intellisense-support):
✔ The pattern is not coupled with any funkwhale types ✔ The pattern is not coupled with any funkwhale types
✔ It's a conventional Ui pattern ✔ It's a conventional UI pattern
::: :::

2
front/ui-docs/index.md
View File

@ -16,7 +16,7 @@ import Spacer from '../src/components/ui/Spacer.vue'
/> />
<Card default raised to="https://design.funkwhale.audio" <Card default raised to="https://design.funkwhale.audio"
title="Ui designs" > title="UI designs" >
Check out the design system on our Penpot. Check out the design system on our Penpot.
</Card> </Card>

4
front/ui-docs/using-components.md
View File

@ -3,7 +3,7 @@
We distinguish between components that are coupled with funkwhale-specific datatypes and "pure" user interface components: We distinguish between components that are coupled with funkwhale-specific datatypes and "pure" user interface components:
- Funkwhale-specific components such as `Activity` or `AlbumCard` import from `types.ts`. - Funkwhale-specific components such as `Activity` or `AlbumCard` import from `types.ts`.
- Pure Ui components (found in `src/components/ui`) are independent from Funkwhale. Think of `Button`, `Tabs` or `Layout` - Pure UI components (found in `src/components/ui`) are independent from Funkwhale. Think of `Button`, `Tabs` or `Layout`
--- ---
@ -60,7 +60,7 @@ As of now, class and variable names from the global styles are not available as
::: :::
## Using Ui components in your views ## Using UI components in your views
```vue ```vue
<script setup> <script setup>