forked from FINAKON/HelpProject
1. Initial Commit - a boiler plate code and POC to realize the concept of context sensitive help 2. Frontend code written in ReactJS 3. Backend code written in Java, Spring Boot Framework 4. Frontend Start: pre-requisites : node, npm npm run dev ==> to start the frontend vite server 5. Backend Start: pre-requisites : java, mvn mvn spring-boot:run ==> to start the backend server 6. Visit http://localhost:5173/ for basic demo of help, press F1 in textboxes 7. Visit http://localhost:5173/editor and enter "admin123" to add/modify texts. Happy Coding !!! Thank you, Bhargava.
69 lines
1.7 KiB
TypeScript
69 lines
1.7 KiB
TypeScript
import Container from './container.js'
|
||
import Node, { NodeProps } from './node.js'
|
||
|
||
declare namespace Comment {
|
||
export interface CommentRaws extends Record<string, unknown> {
|
||
/**
|
||
* The space symbols before the node.
|
||
*/
|
||
before?: string
|
||
|
||
/**
|
||
* The space symbols between `/*` and the comment’s text.
|
||
*/
|
||
left?: string
|
||
|
||
/**
|
||
* The space symbols between the comment’s text.
|
||
*/
|
||
right?: string
|
||
}
|
||
|
||
export interface CommentProps extends NodeProps {
|
||
/** Information used to generate byte-to-byte equal node string as it was in the origin input. */
|
||
raws?: CommentRaws
|
||
/** Content of the comment. */
|
||
text: string
|
||
}
|
||
|
||
// eslint-disable-next-line @typescript-eslint/no-use-before-define
|
||
export { Comment_ as default }
|
||
}
|
||
|
||
/**
|
||
* It represents a class that handles
|
||
* [CSS comments](https://developer.mozilla.org/en-US/docs/Web/CSS/Comments)
|
||
*
|
||
* ```js
|
||
* Once (root, { Comment }) {
|
||
* const note = new Comment({ text: 'Note: …' })
|
||
* root.append(note)
|
||
* }
|
||
* ```
|
||
*
|
||
* Remember that CSS comments inside selectors, at-rule parameters,
|
||
* or declaration values will be stored in the `raws` properties
|
||
* explained above.
|
||
*/
|
||
declare class Comment_ extends Node {
|
||
parent: Container | undefined
|
||
raws: Comment.CommentRaws
|
||
type: 'comment'
|
||
/**
|
||
* The comment's text.
|
||
*/
|
||
get text(): string
|
||
|
||
set text(value: string)
|
||
|
||
constructor(defaults?: Comment.CommentProps)
|
||
assign(overrides: Comment.CommentProps | object): this
|
||
clone(overrides?: Partial<Comment.CommentProps>): this
|
||
cloneAfter(overrides?: Partial<Comment.CommentProps>): this
|
||
cloneBefore(overrides?: Partial<Comment.CommentProps>): this
|
||
}
|
||
|
||
declare class Comment extends Comment_ {}
|
||
|
||
export = Comment
|