0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2025-01-20 22:42:53 -05:00
ghost/apps/comments-ui
Sanne de Vries 4e806f7de4
Ensured replies remain visible when parent comment is being edited (#21756)
REF https://linear.app/ghost/issue/PLG-274/

- Currently, replies are hidden when the parent comment is being edited. This PR ensures that replies remain visible when the parent comment is being edited.
- To achieve this, the `CommentComponent` now checks if the parent comment is being edited. If so, the comment content is swapped by the EditForm, while the comment's avatar, header, menu, and replies remain visible.
- The Form component now only renders the FormEditor. A FormWrapper component is used to wrap the avatar and comment header.
- This Form component is used in the EditForm without the FormWrapper, as it is already wrapped in the CommentComponent.
- The ReplyForm and the MainForm use the FormWrapper.
- The Avatar component now also accepts a `member` prop, which is used to display the avatar image. This is because it's no longer used inside the Form component.
2024-12-02 22:17:15 +00:00
..
src Ensured replies remain visible when parent comment is being edited (#21756) 2024-12-02 22:17:15 +00:00
test Ensured replies remain visible when parent comment is being edited (#21756) 2024-12-02 22:17:15 +00:00
.env
.eslintrc.js Extended translations beta to comments (#17801) 2023-08-24 10:33:03 +02:00
.yarnrc Prevented git tags from being created for apps 2023-07-10 13:09:28 +02:00
LICENSE Migrated from Webpack to Vite and updated dependencies 2023-06-21 15:28:01 +02:00
package.json Wired up admin api for hidden comments (#21724) 2024-11-26 16:56:17 +08:00
playwright.config.ts Refactored comments-ui form management (#21621) 2024-11-14 18:26:23 +00:00
postcss.config.cjs Migrated Comments-UI to TypeScript (#17129) 2023-06-27 14:51:37 +02:00
README.md Updated README of Comments UI with release instructions (#20560) 2024-07-08 16:15:23 +00:00
tailwind.config.js Added Comments Sorting UI (#21375) 2024-10-24 19:01:14 +09:00
tsconfig.json Converted Comments-UI App to TypeScript and React hooks (#17760) 2023-08-18 13:30:59 +00:00
tsconfig.node.json Migrated Comments-UI to TypeScript (#17129) 2023-06-27 14:51:37 +02:00
vite.config.ts Added Dev Container setup (#21279) 2024-10-24 11:15:08 -07:00

Comments UI

Comments widget that is embedded at the bottom of posts in Ghost.

Development

Pre-requisites

  • Run yarn in Ghost monorepo root

Running via Ghost yarn dev in root folder

You can automatically start the comments dev server when developing Ghost by running Ghost (in root folder) via yarn dev --all or yarn dev --comments. This will host the comments JavaScript files, and makes sure that Ghost uses these locally hosted assets instead of the ones from the CDN.

Release

A patch release can be rolled out instantly in production, whereas a minor/major release requires the Ghost monorepo to be updated and released. In either case, you need sufficient permissions to release @tryghost packages on NPM.

Patch release

  1. Run yarn ship and select a patch version when prompted
  2. (Optional) Clear JsDelivr cache to get the new version out instantly (docs). Typically, you'll need to open https://purge.jsdelivr.net/ghost/comments-ui@~${COMMENTS_UI_VERSION}/umd/comments-ui.min.js and https://purge.jsdelivr.net/ghost/comments-ui@~${COMMENTS_UI_VERSION}/umd/main.css in your browser, where COMMENTS_UI_VERSION is the latest minor version in ghost/core/core/shared/config/defaults.json (code)

Minor / major release

  1. Run yarn ship and select a minor or major version when prompted
  2. Update the Comments UI version in ghost/core/core/shared/config/defaults.json to the new minor or major version (code)
  3. Wait until a new version of Ghost is released

Copyright & License

Copyright (c) 2013-2024 Ghost Foundation - Released under the MIT license.