Package: gradio-highlightedcode
gradio_highlightedcodeA variant of the Code component that supports highlighting lines of code.Installationpipinstallgradio_highlightedcodeUsageimporttimeimportgradioasgrfromgradio_highlightedcodeimportHighlightedCodeexample=HighlightedCode().example_inputs()initial_value="""import randomdef scramble_name(name):name_list = list(name)"""completion="""    random.shuffle(name_list)return ''.join(name_list)# Example usage:print(scramble_name("Python"))"""defgenerate_code():foriinrange(len(completion)):time.sleep(0.03)yieldHighlightedCode(initial_value+completion[:i],highlights=[(5,"rgb(255 254 213)")])withgr.Blocks()asdemo:code=HighlightedCode(initial_value,language="python")btn=gr.Button("Generate",variant="primary")btn.click(generate_code,outputs=code)if__name__=="__main__":demo.launch()HighlightedCodeInitializationnametypedefaultdescriptionvaluestr|tuple[str]|NoneNoneDefault value to show in the code editor. If callable, the function will be called whenever the app loads to set the initial value of the component.language"python"|"markdown"|"json"|"html"|"css"|"javascript"|"typescript"|"yaml"|"dockerfile"|"shell"|"r"|NoneNoneThe language to display the code as. Supported languages listed in `gr.Code.languages`.highlightslist[tuple[int,str]]|NoneNoneA list of tuples indicating lines to highlight. The first element of the tuple is the starting line number (1-indexed) and the second element is the highlight color (as a CSS hex string). The highlights are applied in order, with later highlights taking precedence over earlier ones.everyfloat|NoneNoneIf `value` is a callable, run the function 'every' number of seconds while the client connection is open. Has no effect otherwise. The event can be accessed (e.g. to cancel it) via this component's .load_event attribute.linesint5Nonelabelstr|NoneNoneThe label for this component. Appears above the component and is also used as the header if there are a table of examples for this component. If None and used in a `gr.Interface`, the label will be the name of the parameter this component is assigned to.interactivebool|NoneNoneWhether user should be able to enter code or only view it.show_labelbool|NoneNoneif True, will display label.containerboolTrueIf True, will place the component in a container - providing some extra padding around the border.scaleint|NoneNonerelative width compared to adjacent Components in a Row. For example, if Component A has scale=2, and Component B has scale=1, A will be twice as wide as B. Should be an integer.min_widthint160minimum pixel width, will wrap if not sufficient screen space to satisfy this value. If a certain scale value results in this Component being narrower than min_width, the min_width parameter will be respected first.visibleboolTrueIf False, component will be hidden.elem_idstr|NoneNoneAn optional string that is assigned as the id of this component in the HTML DOM. Can be used for targeting CSS styles.elem_classeslist[str]|str|NoneNoneAn optional list of strings that are assigned as the classes of this component in the HTML DOM. Can be used for targeting CSS styles.renderboolTrueIf False, component will not render be rendered in the Blocks context. Should be used if the intention is to assign event listeners now but render the component later.EventsnamedescriptionchangeTriggered when the value of the HighlightedCode changes either because of user input (e.g. a user types in a textbox) OR because of a function update (e.g. an image receives a value from the output of an event trigger). See.input()for a listener that is only triggered by user input.inputThis listener is triggered when the user changes the value of the HighlightedCode.focusThis listener is triggered when the HighlightedCode is focused.blurThis listener is triggered when the HighlightedCode is unfocused/blurred.User functionThe impact on the users predict function varies depending on whether the component is used as an input or output for an event (or both).When used as an Input, the component only impacts the input signature of the user function.When used as an output, the component only impacts the return signature of the user function.The code snippet below is accurate in cases where the component is used as both an input and an output.As output:Is passed, passes the code entered as astr.As input:Should return, expects astrof code or a single-elementtuple: (filepath,) with thestrpath to a file containing the code.defpredict(value:str|None)->tuple[str]|str|None:returnvalue